{"_id":"@youdotcom-oss/sdk","_rev":"10-829cf9ba789091c2e7c3ef22b75c41f4","name":"@youdotcom-oss/sdk","dist-tags":{"latest":"0.13.1"},"versions":{"0.10.16":{"name":"@youdotcom-oss/sdk","version":"0.10.16","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.10.16","maintainers":[{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"fb157252325641cfdf3a516742b689652828687c","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.10.16.tgz","fileCount":780,"integrity":"sha512-qK485GxlZmfk1WedFr8MFNcMMVTelCF+w0FX88fJd8xjEZ98aBUpWkmTfOofwD5W9SvA4QVwdUWloL6qqBmqnA==","signatures":[{"sig":"MEUCIGqXRKOGNWpX06qEubriM5PKo7F57AFuIqe6MYGi1PxTAiEAmo/jsZmpzm+PLGGzPjC/49vTzKJWUDUBFIRf5pL3e1w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1305578},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"d27e326847820d35d98d57ff95aa96cc94fc572c","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.6.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.11.1","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.10.16_1765316381429_0.9685209217311292","host":"s3://npm-registry-packages-npm-production"}},"0.10.18":{"name":"@youdotcom-oss/sdk","version":"0.10.18","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.10.18","maintainers":[{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"a7e1adeac41adb7f9813013e97bc4ced6ae14d0d","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.10.18.tgz","fileCount":780,"integrity":"sha512-ryvWVE+e5VN5S6j3D+zsCQzPsYW+HeCY6a1YxTU0HYZqwqJIBN29wOmYKqEjQJpeREZc7GqpUkf8zlJCA0pfig==","signatures":[{"sig":"MEUCICGcqxsrcWN8yYO5G5fsGhN9YTedJWNe68wCI97jZE3NAiEAhnsbct2PoWvMN+1IURTX5lu9b3NUccpRZmGTcYmNL7I=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1305268},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"78573ac692b2df882870f02c3ffc08640f53e072","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.6.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.11.1","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.10.18_1765329619521_0.7882500917815582","host":"s3://npm-registry-packages-npm-production"}},"0.10.20":{"name":"@youdotcom-oss/sdk","version":"0.10.20","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.10.20","maintainers":[{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"37a8ef5bd85b74f14ab82fd136c612aaa4216e8e","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.10.20.tgz","fileCount":780,"integrity":"sha512-5xiHNvMwph1BU4EtpQxuaVVzdmJJbJJ99n6YS2Lz0CtiGvBWAwqMw3acDoY+uLGLmbSKoIckCT71WZwT7EVqIg==","signatures":[{"sig":"MEQCIDKjuweh0YJQjQiw3wUtZyY4YhMQbg7lIyOlYtMJrOewAiATKKtwEX7XZcesOLBxXVWqSxf4WK0kq/hRjcVkf4XM9w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1309998},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"80a63bf8b3ca1d0b57faf409cb91f43c6857ee97","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.6.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.11.1","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.10.20_1765413749859_0.588342653842717","host":"s3://npm-registry-packages-npm-production"}},"0.10.21":{"name":"@youdotcom-oss/sdk","version":"0.10.21","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.10.21","maintainers":[{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"d5287be689a09a26a61d37fa2997a189f46fd5bd","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.10.21.tgz","fileCount":783,"integrity":"sha512-EDYX1TbZNOzwnTa/GUYy1sNu+CsbkTXnj01ST96srbaWVcIec5zN2u5ENEAgsGAVEpd6QfSu450fIQrPNGeChw==","signatures":[{"sig":"MEQCIED/ZmHk6fBeMdqooEwKkAl4XLQf3lxM/EhH0/gQw+71AiBz9SYnXXRwjHn/RHKpV+Qruj7suvL6DQntNgl+0xhBxw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1326865},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"1c4cdfb05782de27def2be499d5ee03fec797e40","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.6.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.12.0","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.10.21_1767895829565_0.42702082866527835","host":"s3://npm-registry-packages-npm-production"}},"0.13.0":{"name":"@youdotcom-oss/sdk","version":"0.13.0","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.13.0","maintainers":[{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"b53dd40c54913d013381c90983be4ed0ac640637","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.13.0.tgz","fileCount":819,"integrity":"sha512-agTyzKLWQMTj2RagRU2Gg3q43MlX/JLrrujAzRDG5fuHMDOT6B6TqakIoeAZ1duoGOX5E4/tB0v28TMqHRdHiA==","signatures":[{"sig":"MEYCIQC/9RS+fSrnME0KV9yrEaW8sJBFrxj6DLyA39jxNPSQAAIhAO0kByAtPXDCyoOwepXgcdOhBZH8/+m4NdoTMWrIOIEy","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1339740},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"2c1d630a35129407353e38bd7dc567d8ea9a4e07","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.6.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.13.0","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.13.0_1770313074217_0.35585278789596697","host":"s3://npm-registry-packages-npm-production"}},"0.13.1":{"name":"@youdotcom-oss/sdk","version":"0.13.1","author":{"name":"Speakeasy"},"_id":"@youdotcom-oss/sdk@0.13.1","maintainers":[{"name":"tyleratydc","email":"tyler@you.com"},{"name":"kevinatyou","email":"kevin@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"adamp-at-you","email":"adamp@you.com"}],"dist":{"shasum":"99d38ebb096b1f7b12b907b1772dcef7ca6bdef2","tarball":"https://registry.npmjs.org/@youdotcom-oss/sdk/-/sdk-0.13.1.tgz","fileCount":839,"integrity":"sha512-SancHVQc9oxZjZxTGoASmhOvCk1f9To4yRLfp3eDMGenNZcy37zPYYqHmCYXtJFnlxJEKmSniQPnnraeVEsw3g==","signatures":[{"sig":"MEUCIQC0OBroxoXLPGm0rXk3qwzK2blxbtVn573GIp0sPYLiDQIgL4BR2H2kL2FdI4fjgi0wVaSsmNe6TmFqeIUIWxydCCU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1447867},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./models":"./src/models/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@youdotcom-oss/sdk/source"]},"type":"module","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js","@youdotcom-oss/sdk/source":"./src/index.ts"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./*":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@youdotcom-oss/sdk/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./types":{"import":{"types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js","@youdotcom-oss/sdk/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models":{"import":{"types":"./dist/esm/models/index.d.ts","default":"./dist/esm/models/index.js","@youdotcom-oss/sdk/source":"./src/models/index.ts"},"require":{"types":"./dist/commonjs/models/index.d.ts","default":"./dist/commonjs/models/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@youdotcom-oss/sdk/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@youdotcom-oss/sdk/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"343eaade3dd7ed3c7039c64637761caf727ac612","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build","test:integration":"node --import tsx --test tests/*.test.ts"},"_npmUser":{"name":"kevinatyou","email":"kevin@you.com"},"deprecated":"This package is deprecated.\n Please use @youdotcom-oss/mcp instead:\n https://www.npmjs.com/package/@youdotcom-oss/mcp","_npmVersion":"11.8.0","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.13.1","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.19.0","tshy":"^2.0.0","eslint":"^9.26.0","globals":"^15.14.0","@eslint/js":"^9.26.0","typescript":"~5.8.3","@types/node":"^22.0.0","typescript-eslint":"^8.26.0"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.13.1_1772558989918_0.43528401164264907","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-12-09T21:39:41.367Z","modified":"2026-09-16T18:44:43.909Z","0.10.16":"2025-12-09T21:39:41.591Z","0.10.18":"2025-12-10T01:20:19.732Z","0.10.20":"2025-12-11T00:42:30.073Z","0.10.21":"2026-01-08T18:10:29.816Z","0.13.0":"2026-02-05T17:37:54.441Z","0.13.1":"2026-03-03T17:29:50.132Z"},"author":{"name":"Speakeasy"},"description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.","maintainers":[{"name":"adamp-at-you","email":"adamp@you.com"},{"name":"edwardirby-ydc","email":"edward@you.com"},{"name":"opensource-at-you","email":"opensource@you.com"},{"name":"tyleratydc","email":"tyler@you.com"}],"readme":"# youdotcom\n\nDeveloper-friendly & type-safe Typescript SDK specifically catered to leverage *youdotcom* API.\n\n[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=youdotcom&utm_campaign=typescript)\n[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)\n\n<!-- Start Summary [summary] -->\n## Summary\n\nYou.com API: Unified API for Express, Advanced, and Custom Agents from You.com\nGet the best search results from web and news sources\nReturns the HTML or Markdown of a target webpage\nMulti-step reasoning with comprehensive research capabilities\nComprehensive API for You.com services:\n- **Agents API**: Execute queries using Express, Advanced, and Custom AI agents\n- **Search API**: Get search results from web and news sources\n- **Contents API**: Retrieve and process web page content\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [youdotcom](#youdotcom)\n  * [SDK Installation](#sdk-installation)\n  * [Requirements](#requirements)\n  * [SDK Example Usage](#sdk-example-usage)\n  * [Authentication](#authentication)\n  * [Available Resources and Operations](#available-resources-and-operations)\n  * [Standalone functions](#standalone-functions)\n  * [Server-sent event streaming](#server-sent-event-streaming)\n  * [Retries](#retries)\n  * [Error Handling](#error-handling)\n  * [Server Selection](#server-selection)\n  * [Custom HTTP Client](#custom-http-client)\n  * [Debugging](#debugging)\n* [Development](#development)\n  * [Maturity](#maturity)\n  * [Contributions](#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nThe SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.\n\n### NPM\n\n```bash\nnpm add @youdotcom-oss/sdk\n```\n\n### PNPM\n\n```bash\npnpm add @youdotcom-oss/sdk\n```\n\n### Bun\n\n```bash\nbun add @youdotcom-oss/sdk\n```\n\n### Yarn\n\n```bash\nyarn add @youdotcom-oss/sdk\n```\n\n> [!NOTE]\n> This package is published with CommonJS and ES Modules (ESM) support.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start Requirements [requirements] -->\n## Requirements\n\nFor supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).\n<!-- End Requirements [requirements] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\nWe provide a comprehensive example file with interactive demos for all API endpoints. You can find it at [`examples/api-example-calls.ts`](examples/api-example-calls.ts).\n\nTo run the examples:\n\n```bash\ncd examples\nnpm install\nnpx tsx api-example-calls.ts\n```\n\nThe example file includes:\n- **Research API** - Runs multiple searches, reads sources, and synthesizes a thorough, well-cited answer\n- **Express Agent** - Fast responses with optional web search, available as batch or streaming\n- **Advanced Agent** - Complex queries with multi-turn reasoning, planning, and tool usage\n- **Custom Agent** - Queries routed through your own agent configurations created in the You.com UI\n- **Search API** - LLM-ready web and news results with optional livecrawl for full page content\n- **Contents API** - Fetches and returns the HTML or Markdown of any target webpage\n\n### SDK Performance\n\nThe `api-performance.ts` script lets you benchmark the Search API and measure the SDK's overhead:\n\n```bash\nnpx tsx api-performance.ts\n```\n\nThis runs three benchmarks:\n1. **curl** — HTTP performance baseline\n2. **TypeScript SDK** — Full SDK with network requests\n3. **TypeScript SDK (Mocked)** — SDK processing only, no network latency\n\nThe mocked benchmark isolates the SDK's computational overhead (validation, request building, response parsing) from network latency, giving you a pure measurement of SDK performance.\n\nThe SDK typically adds less than a millisecond of overhead to API calls, demonstrating that the cost of using the SDK over raw HTTP is minimal. In fact, its comperable to using curl directly.\n\nAn example call is as follows:\n\n```\n╔════════════════════════════════════════════════════╗\n║   Search API Benchmark: curl vs TypeScript SDK     ║\n╚════════════════════════════════════════════════════╝\n\n🔑 Enter your API key: ***\n\n🔄 Running 10 iterations each...\n📝 Query: \"What are the latest geopolitical updates from India\"\n\n🌐 Running curl benchmark...\n\n   Run 1: 404.58 ms\n   Run 2: 119.72 ms\n   Run 3: 188.51 ms\n   Run 4: 118.26 ms\n   Run 5: 120.73 ms\n   Run 6: 117.17 ms\n   Run 7: 160.49 ms\n   Run 8: 115.51 ms\n   Run 9: 112.05 ms\n   Run 10: 149.28 ms\n\n📊 curl Results:\n   Average: 160.63 ms\n   Min:     112.05 ms\n   Max:     404.58 ms\n\n📦 Running TypeScript SDK benchmark...\n\n   Run 1: 426.05 ms\n   Run 2: 119.36 ms\n   Run 3: 122.89 ms\n   Run 4: 110.39 ms\n   Run 5: 118.86 ms\n   Run 6: 127.69 ms\n   Run 7: 164.59 ms\n   Run 8: 115.04 ms\n   Run 9: 121.81 ms\n   Run 10: 106.95 ms\n\n📊 TypeScript SDK Results:\n   Average: 153.36 ms\n   Min:     106.95 ms\n   Max:     426.05 ms\n\n🧪 Running TypeScript SDK benchmark (mocked network)...\n\n   Run 1: 0.67 ms\n   Run 2: 0.25 ms\n   Run 3: 0.16 ms\n   Run 4: 0.14 ms\n   Run 5: 0.14 ms\n   Run 6: 0.48 ms\n   Run 7: 0.16 ms\n   Run 8: 0.24 ms\n   Run 9: 0.34 ms\n   Run 10: 0.16 ms\n\n📊 TypeScript SDK (Mocked) Results:\n   Average: 0.27 ms\n   Min:     0.14 ms\n   Max:     0.67 ms\n\n═══════════════════════════════════════════════════════\n📈 COMPARISON\n═══════════════════════════════════════════════════════\n\n📊 curl vs TypeScript SDK (with network):\n   TypeScript SDK is 7.27 ms faster on average\n   TypeScript SDK is 1.05x faster than curl\n\n📊 SDK Performance Breakdown:\n   SDK processing overhead:           0.27 ms\n   Total SDK time (with network):     153.36 ms\n   SDK overhead as % of total:        0.2%\n```\n\n<!-- No SDK Example Usage [usage] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name         | Type   | Scheme  | Environment Variable |\n| ------------ | ------ | ------- | -------------------- |\n| `apiKeyAuth` | apiKey | API key | `YOU_API_KEY_AUTH`   |\n\nTo authenticate with the API the `apiKeyAuth` parameter must be set when initializing the SDK client instance. For example:\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst you = new You({\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await you.agentsRuns({\n    agent: \"express\",\n    input: \"What is the capital of France?\",\n    stream: false,\n  });\n\n  console.log(result);\n}\n\nrun();\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [You SDK](docs/sdks/you/README.md)\n\n* [agentsRuns](docs/sdks/you/README.md#agentsruns) - Run an Agent\n* [search](docs/sdks/you/README.md#search) - Returns a list of unified search results from web and news sources\n* [contents](docs/sdks/you/README.md#contents) - Returns the content of the web pages\n* [research](docs/sdks/you/README.md#research) - Returns comprehensive research-grade answers with multi-step reasoning\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Standalone functions [standalone-funcs] -->\n## Standalone functions\n\nAll the methods listed above are available as standalone functions. These\nfunctions are ideal for use in applications running in the browser, serverless\nruntimes or other environments where application bundle size is a primary\nconcern. When using a bundler to build your application, all unused\nfunctionality will be either excluded from the final bundle or tree-shaken away.\n\nTo read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).\n\n<details>\n\n<summary>Available standalone functions</summary>\n\n- [`agentsRuns`](docs/sdks/you/README.md#agentsruns) - Run an Agent\n- [`contents`](docs/sdks/you/README.md#contents) - Returns the content of the web pages\n- [`research`](docs/sdks/you/README.md#research) - Returns comprehensive research-grade answers with multi-step reasoning\n- [`search`](docs/sdks/you/README.md#search) - Returns a list of unified search results from web and news sources\n\n</details>\n<!-- End Standalone functions [standalone-funcs] -->\n\n<!-- Start Server-sent event streaming [eventstream] -->\n## Server-sent event streaming\n\n[Server-sent events][mdn-sse] are used to stream content from certain\noperations. These operations will expose the stream as an async iterable that\ncan be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will\nterminate when the server no longer has any events to send and closes the\nunderlying connection.\n\n```typescript\nimport { You } from \"youdotcom\";\nimport {\n  type ExpressAgentRunsRequest,\n  type AgentRunsStreamingResponse,\n} from \"youdotcom/models\"\nimport { type EventStream } from \"youdotcom/lib/event-streams.js\";\n\nconst you = new You({\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nconst request: ExpressAgentRunsRequest = {\n  agent: \"express\",\n  stream: true,\n  input: \"Restaurants in San Francisco\",\n  tools: [{\n    type: \"web_search\"\n  }]\n};\n\nasync function run() {\n  const result = await you.agentsRuns(request) as EventStream<AgentRunsStreamingResponse>;\n\n  // Iterate over the streaming response and print tokens as they arrive\n  for await (const chunk of result) {\n    switch(chunk.data.type) {\n      case \"response.created\": {\n        console.log(\"Response created, seqId:\", chunk.data.seqId);\n        break;\n      }\n      case \"response.starting\": {\n        console.log(\"Response starting, seqId:\", chunk.data.seqId);\n        break;\n      }\n      case \"response.output_item.added\": {\n        console.log(\"Output item added:\", chunk.data);\n        break;\n      }\n      case \"response.output_content.full\": {\n        console.log(\"\\nWeb Search Results:\");\n        let urls = chunk.data.response.full.map((result) => {\n          return result.url\n        })\n        console.log(urls);\n        break;\n      }\n      case \"response.output_text.delta\": {\n        // This contains the incremental response from the agent\n        process.stdout.write(chunk.data.response.delta)\n        break;\n      }\n      case \"response.output_item.done\": {\n        console.log(\"\\nOutput item done:\", chunk.data);\n        break;\n      }\n      case \"response.done\": {\n        console.log(\"\\nResponse completed!\");\n        console.log(\"Runtime:\", chunk.data.response.runTimeMs, \"ms\");\n        console.log(\"Finished:\", chunk.data.response.finished);\n        break;\n      }\n      default: {\n        console.log(\"Unknown event type:\", chunk.data);\n        break;\n      }\n    }\n  }\n}\n\nrun();\n```\n\n[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events\n[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of\n<!-- No Server-sent event streaming [eventstream] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a retryConfig object to the call:\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst you = new You({\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await you.agentsRuns({\n    agent: \"express\",\n    input: \"What is the capital of France?\",\n    stream: false,\n  }, {\n    retries: {\n      strategy: \"backoff\",\n      backoff: {\n        initialInterval: 1,\n        maxInterval: 50,\n        exponent: 1.1,\n        maxElapsedTime: 100,\n      },\n      retryConnectionErrors: false,\n    },\n  });\n\n  console.log(result);\n}\n\nrun();\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst you = new You({\n  retryConfig: {\n    strategy: \"backoff\",\n    backoff: {\n      initialInterval: 1,\n      maxInterval: 50,\n      exponent: 1.1,\n      maxElapsedTime: 100,\n    },\n    retryConnectionErrors: false,\n  },\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await you.agentsRuns({\n    agent: \"express\",\n    input: \"What is the capital of France?\",\n    stream: false,\n  });\n\n  console.log(result);\n}\n\nrun();\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\n[`YouError`](./src/models/errors/youerror.ts) is the base class for all HTTP error responses. It has the following properties:\n\n| Property            | Type       | Description                                                                             |\n| ------------------- | ---------- | --------------------------------------------------------------------------------------- |\n| `error.message`     | `string`   | Error message                                                                           |\n| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |\n| `error.headers`     | `Headers`  | HTTP response headers                                                                   |\n| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |\n| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |\n| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |\n\n### Example\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\nimport * as errors from \"@youdotcom-oss/sdk/models/errors\";\n\nconst you = new You({\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  try {\n    const result = await you.agentsRuns({\n      agent: \"express\",\n      input: \"What is the capital of France?\",\n      stream: false,\n    });\n\n    console.log(result);\n  } catch (error) {\n    // The base class for HTTP error responses\n    if (error instanceof errors.YouError) {\n      console.log(error.message);\n      console.log(error.statusCode);\n      console.log(error.body);\n      console.log(error.headers);\n\n      // Depending on the method different errors may be thrown\n      if (error instanceof errors.AgentRuns400ResponseError) {\n        console.log(error.data$.detail); // string\n      }\n    }\n  }\n}\n\nrun();\n\n```\n\n### Error Classes\n**Primary error:**\n* [`YouError`](./src/models/errors/youerror.ts): The base class for HTTP error responses.\n\n<details><summary>Less common errors (19)</summary>\n\n<br />\n\n**Network errors:**\n* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.\n* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.\n* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.\n* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.\n* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.\n\n\n**Inherit from [`YouError`](./src/models/errors/youerror.ts)**:\n* [`AgentRuns400ResponseError`](./src/models/errors/agentruns400responseerror.ts): The message returned by the error. Status code `400`. Applicable to 1 of 4 methods.*\n* [`AgentRuns401ResponseError`](./src/models/errors/agentruns401responseerror.ts): The message returned by the error. Status code `401`. Applicable to 1 of 4 methods.*\n* [`SearchUnauthorizedError`](./src/models/errors/searchunauthorizederror.ts): Unauthorized. Problems with API key. Status code `401`. Applicable to 1 of 4 methods.*\n* [`ContentsUnauthorizedError`](./src/models/errors/contentsunauthorizederror.ts): Unauthorized. Problems with API key. Status code `401`. Applicable to 1 of 4 methods.*\n* [`ResearchUnauthorizedError`](./src/models/errors/researchunauthorizederror.ts): Unauthorized. Problems with API key. Status code `401`. Applicable to 1 of 4 methods.*\n* [`SearchForbiddenError`](./src/models/errors/searchforbiddenerror.ts): Forbidden. API key lacks scope for this path. Status code `403`. Applicable to 1 of 4 methods.*\n* [`ContentsForbiddenError`](./src/models/errors/contentsforbiddenerror.ts): Forbidden. API key lacks scope for this path. Status code `403`. Applicable to 1 of 4 methods.*\n* [`ResearchForbiddenError`](./src/models/errors/researchforbiddenerror.ts): Forbidden. API key lacks scope for this path. Status code `403`. Applicable to 1 of 4 methods.*\n* [`AgentRuns422ResponseError`](./src/models/errors/agentruns422responseerror.ts): Unprocessable Entity - Invalid request data. Status code `422`. Applicable to 1 of 4 methods.*\n* [`UnprocessableEntityError`](./src/models/errors/unprocessableentityerror.ts): Unprocessable Entity. Request validation failed. Status code `422`. Applicable to 1 of 4 methods.*\n* [`SearchInternalServerError`](./src/models/errors/searchinternalservererror.ts): Internal Server Error during authentication/authorization middleware. Status code `500`. Applicable to 1 of 4 methods.*\n* [`ContentsInternalServerError`](./src/models/errors/contentsinternalservererror.ts): Internal Server Error during authentication/authorization middleware. Status code `500`. Applicable to 1 of 4 methods.*\n* [`ResearchInternalServerError`](./src/models/errors/researchinternalservererror.ts): Internal Server Error during authentication/authorization middleware. Status code `500`. Applicable to 1 of 4 methods.*\n* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.\n\n</details>\n\n\\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst you = new You({\n  serverURL: \"https://api.you.com\",\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await you.agentsRuns({\n    agent: \"express\",\n    input: \"What is the capital of France?\",\n    stream: false,\n  });\n\n  console.log(result);\n}\n\nrun();\n\n```\n\n### Override Server URL Per-Operation\n\nThe server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst you = new You({\n  apiKeyAuth: process.env[\"YOU_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await you.search({}, {\n    serverURL: \"https://ydc-index.io\",\n  });\n\n  console.log(result);\n}\n\nrun();\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe TypeScript SDK makes API calls using an `HTTPClient` that wraps the native\n[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This\nclient is a thin wrapper around `fetch` and provides the ability to attach hooks\naround the request lifecycle that can be used to modify the request or handle\nerrors and response.\n\nThe `HTTPClient` constructor takes an optional `fetcher` argument that can be\nused to integrate a third-party HTTP client or when writing tests to mock out\nthe HTTP client and feed in fixtures.\n\nThe following example shows how to:\n- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent\n- use the `\"beforeRequest\"` hook to add a custom header and a timeout to requests\n- use the `\"requestError\"` hook to log errors\n\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\nimport { ProxyAgent } from \"undici\";\nimport { HTTPClient } from \"@youdotcom-oss/sdk/lib/http\";\n\nconst dispatcher = new ProxyAgent(\"http://proxy.example.com:8080\");\n\nconst httpClient = new HTTPClient({\n  // 'fetcher' takes a function that has the same signature as native 'fetch'.\n  fetcher: (input, init) =>\n    // 'dispatcher' is specific to undici and not part of the standard Fetch API.\n    fetch(input, { ...init, dispatcher } as RequestInit),\n});\n\nhttpClient.addHook(\"beforeRequest\", (request) => {\n  const nextRequest = new Request(request, {\n    signal: request.signal || AbortSignal.timeout(5000)\n  });\n\n  nextRequest.headers.set(\"x-custom-header\", \"custom value\");\n\n  return nextRequest;\n});\n\nhttpClient.addHook(\"requestError\", (error, request) => {\n  console.group(\"Request Error\");\n  console.log(\"Reason:\", `${error}`);\n  console.log(\"Endpoint:\", `${request.method} ${request.url}`);\n  console.groupEnd();\n});\n\nconst sdk = new You({ httpClient: httpClient });\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass a logger that matches `console`'s interface as an SDK option.\n\n> [!WARNING]\n> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.\n\n```typescript\nimport { You } from \"@youdotcom-oss/sdk\";\n\nconst sdk = new You({ debugLogger: console });\n```\n\nYou can also enable a default debug logger by setting an environment variable `YOU_DEBUG` to true.\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, note that all files in this repository, with the exception of [`examples/api-example-calls.ts`](examples/api-example-calls.ts) and the [`openapi_schemas`](openapi_schemas) folder, are automatically generated by Speakeasy. Any manual changes outside of these files will be overwritten on the next generation.\n\nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.\n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=youdotcom&utm_campaign=typescript)\n","readmeFilename":"README.md"}