{"_id":"@abbyy-sdk/document-ai","_rev":"5-11377b8d826751c55429c4cfd0601b02","name":"@abbyy-sdk/document-ai","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.0":{"name":"@abbyy-sdk/document-ai","version":"0.1.0","author":{"name":"Speakeasy"},"_id":"@abbyy-sdk/document-ai@0.1.0","maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"dist":{"shasum":"b73407d973a24e2831bb6d2698132f4a5acf31de","tarball":"https://registry.npmjs.org/@abbyy-sdk/document-ai/-/document-ai-0.1.0.tgz","fileCount":2208,"integrity":"sha512-21ThuuZ3+spfucxuW/h0CFRTbVsRxbRVTmna+cbfDfu5UQUiYw8vkH3ehOb50x/QR0huPVdyk4EzvJdbaMBO5A==","signatures":[{"sig":"MEUCIGDpaSsBS6SVd9qwjg+y7NLs1zxk/vUn4reXBHcf8gBoAiEAk3n1UgZNMhqiNSQIHQCODvmoU5L0Ik63t7gvDaEOM7E=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":10469487},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/components":"./src/models/components/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@abbyy-sdk/document-ai/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/components":{"import":{"types":"./dist/esm/models/components/index.d.ts","default":"./dist/esm/models/components/index.js","@abbyy-sdk/document-ai/source":"./src/models/components/index.ts"},"require":{"types":"./dist/commonjs/models/components/index.d.ts","default":"./dist/commonjs/models/components/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@abbyy-sdk/document-ai/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"fea9b1533bd3ae5ae81202885af49426842096e0","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build"},"_npmUser":{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"},"repository":{"url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git","type":"git"},"_npmVersion":"8.19.4","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","dependencies":{"jsonpath-rfc9535":"1.1.0"},"_hasShrinkwrap":false,"devDependencies":{"zod":"^3.23.4","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0"},"peerDependencies":{"zod":">= 3"},"_npmOperationalInternal":{"tmp":"tmp/document-ai_0.1.0_1744127750461_0.2601665955289105","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@abbyy-sdk/document-ai","version":"0.1.1","author":{"name":"Speakeasy"},"_id":"@abbyy-sdk/document-ai@0.1.1","maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"dist":{"shasum":"9b5dd7cf0bc91a709b7d74578c72c2990df3481b","tarball":"https://registry.npmjs.org/@abbyy-sdk/document-ai/-/document-ai-0.1.1.tgz","fileCount":2442,"integrity":"sha512-qc7N9BOYMu4eAZYpfrwgLzBHbq5yP/Xb4C84/M3Z64xTrKiPgxUdmpzdsxkpbgq8xvULpit2NN0ld5pQj5TKIQ==","signatures":[{"sig":"MEQCIFk9HkWY0/qYDmV5UxM/Sw0OydzM6bUqZ/Sf65/4+rjIAiBFwDGQc2EiVVSxt+mZ618iR7Auc51PMIaPz690tjFEZA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":10567268},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/components":"./src/models/components/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@abbyy-sdk/document-ai/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/components":{"import":{"types":"./dist/esm/models/components/index.d.ts","default":"./dist/esm/models/components/index.js","@abbyy-sdk/document-ai/source":"./src/models/components/index.ts"},"require":{"types":"./dist/commonjs/models/components/index.d.ts","default":"./dist/commonjs/models/components/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@abbyy-sdk/document-ai/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"42fe8989e65e9034471cfc50b6ffadd50e0c1d80","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build"},"_npmUser":{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"},"repository":{"url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git","type":"git"},"_npmVersion":"8.19.4","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","dependencies":{"jsonpath-rfc9535":"1.1.0"},"_hasShrinkwrap":false,"devDependencies":{"zod":"^3.23.4","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0"},"peerDependencies":{"zod":">= 3"},"_npmOperationalInternal":{"tmp":"tmp/document-ai_0.1.1_1744300150584_0.6259087498242291","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@abbyy-sdk/document-ai","version":"0.1.2","author":{"name":"Speakeasy"},"_id":"@abbyy-sdk/document-ai@0.1.2","maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"dist":{"shasum":"398d4c42f9431354a6ff7a354afbe1eff8d32302","tarball":"https://registry.npmjs.org/@abbyy-sdk/document-ai/-/document-ai-0.1.2.tgz","fileCount":2460,"integrity":"sha512-vFS9F6l6Azxq8J6dBvv2ISn7MYOQCJT8U2l2zOC6/2THzUvWYJlaSBYX+qcqxYoKLIAvgg5TN9T3wHYoHZztYw==","signatures":[{"sig":"MEUCIDQbazhGwHT/xO/gOpMAtCKPt4aoxdFX03HIUZodAYp+AiEAzTiMsCwDIwAMvf5qbgXj1Oq2KdHGizuSQCyMmjnmTH8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":10627067},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/components":"./src/models/components/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@abbyy-sdk/document-ai/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/components":{"import":{"types":"./dist/esm/models/components/index.d.ts","default":"./dist/esm/models/components/index.js","@abbyy-sdk/document-ai/source":"./src/models/components/index.ts"},"require":{"types":"./dist/commonjs/models/components/index.d.ts","default":"./dist/commonjs/models/components/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@abbyy-sdk/document-ai/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"74fc6fe3b071f9fee864dd31f25a85643f4ac08a","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build"},"_npmUser":{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"},"repository":{"url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git","type":"git"},"_npmVersion":"8.19.4","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","dependencies":{"jsonpath-rfc9535":"1.1.0"},"_hasShrinkwrap":false,"devDependencies":{"zod":"^3.23.4","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0"},"peerDependencies":{"zod":">= 3"},"_npmOperationalInternal":{"tmp":"tmp/document-ai_0.1.2_1744321870839_0.2266799645759523","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@abbyy-sdk/document-ai","version":"0.1.3","author":{"name":"Speakeasy"},"_id":"@abbyy-sdk/document-ai@0.1.3","maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"dist":{"shasum":"99207a47add987e1859d466fa72033373542a2ca","tarball":"https://registry.npmjs.org/@abbyy-sdk/document-ai/-/document-ai-0.1.3.tgz","fileCount":2460,"integrity":"sha512-JssGrh0hw7Q1QM+6NGTswV+DMaGR22F1bC6EpJuBDkEZ9etITq3oCxT1zLZkfd/NhtRk48SS5wCczGdug5jqBg==","signatures":[{"sig":"MEUCIQCpgeG0X/1NBSWrzVcoptTBtLe1I+Gjag7XCBRtkMvfgAIgCGwcUtuygDewcX25wJ/0YsJM+qmJ/3p5GMGb4VUMJ3Q=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":10626690},"main":"./dist/commonjs/index.js","tshy":{"exports":{".":"./src/index.ts","./*":"./src/*.ts","./*.js":"./src/*.ts","./types":"./src/types/index.ts","./package.json":"./package.json","./models/errors":"./src/models/errors/index.ts","./models/components":"./src/models/components/index.ts","./models/operations":"./src/models/operations/index.ts"},"sourceDialects":["@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/*.ts"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*.js":{"import":{"types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js","@abbyy-sdk/document-ai/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","@abbyy-sdk/document-ai/source":"./src/types/index.ts"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./package.json":"./package.json","./models/errors":{"import":{"types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js","@abbyy-sdk/document-ai/source":"./src/models/errors/index.ts"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/components":{"import":{"types":"./dist/esm/models/components/index.d.ts","default":"./dist/esm/models/components/index.js","@abbyy-sdk/document-ai/source":"./src/models/components/index.ts"},"require":{"types":"./dist/commonjs/models/components/index.d.ts","default":"./dist/commonjs/models/components/index.js"}},"./models/operations":{"import":{"types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js","@abbyy-sdk/document-ai/source":"./src/models/operations/index.ts"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}}},"gitHead":"8765bc01c6a6db7f782cdff66006e80ff2f7fb5b","scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build"},"_npmUser":{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"},"repository":{"url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git","type":"git"},"_npmVersion":"8.19.4","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","directories":{},"sideEffects":false,"_nodeVersion":"16.20.2","dependencies":{"jsonpath-rfc9535":"1.1.0"},"_hasShrinkwrap":false,"devDependencies":{"zod":"^3.23.4","tshy":"^2.0.0","eslint":"^9.19.0","globals":"^15.14.0","@eslint/js":"^9.19.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0"},"peerDependencies":{"zod":">= 3"},"_npmOperationalInternal":{"tmp":"tmp/document-ai_0.1.3_1744405632451_0.921617941743383","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@abbyy-sdk/document-ai","version":"0.1.4","author":{"name":"Speakeasy"},"type":"module","tshy":{"sourceDialects":["@abbyy-sdk/document-ai/source"],"exports":{".":"./src/index.ts","./package.json":"./package.json","./types":"./src/types/index.ts","./models/errors":"./src/models/errors/index.ts","./models/components":"./src/models/components/index.ts","./models/operations":"./src/models/operations/index.ts","./*.js":"./src/*.ts","./*":"./src/*.ts"}},"sideEffects":false,"repository":{"type":"git","url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git"},"scripts":{"lint":"eslint --cache --max-warnings=0 src","build":"tshy","prepublishOnly":"npm run build"},"peerDependencies":{"zod":">= 3"},"devDependencies":{"@eslint/js":"^9.19.0","eslint":"^9.19.0","globals":"^15.14.0","tshy":"^2.0.0","typescript":"^5.4.5","typescript-eslint":"^8.22.0","zod":"^3.23.4"},"dependencies":{"jsonpath-rfc9535":"1.1.0"},"exports":{".":{"import":{"@abbyy-sdk/document-ai/source":"./src/index.ts","types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/commonjs/index.d.ts","default":"./dist/commonjs/index.js"}},"./package.json":"./package.json","./types":{"import":{"@abbyy-sdk/document-ai/source":"./src/types/index.ts","types":"./dist/esm/types/index.d.ts","default":"./dist/esm/types/index.js"},"require":{"types":"./dist/commonjs/types/index.d.ts","default":"./dist/commonjs/types/index.js"}},"./models/errors":{"import":{"@abbyy-sdk/document-ai/source":"./src/models/errors/index.ts","types":"./dist/esm/models/errors/index.d.ts","default":"./dist/esm/models/errors/index.js"},"require":{"types":"./dist/commonjs/models/errors/index.d.ts","default":"./dist/commonjs/models/errors/index.js"}},"./models/components":{"import":{"@abbyy-sdk/document-ai/source":"./src/models/components/index.ts","types":"./dist/esm/models/components/index.d.ts","default":"./dist/esm/models/components/index.js"},"require":{"types":"./dist/commonjs/models/components/index.d.ts","default":"./dist/commonjs/models/components/index.js"}},"./models/operations":{"import":{"@abbyy-sdk/document-ai/source":"./src/models/operations/index.ts","types":"./dist/esm/models/operations/index.d.ts","default":"./dist/esm/models/operations/index.js"},"require":{"types":"./dist/commonjs/models/operations/index.d.ts","default":"./dist/commonjs/models/operations/index.js"}},"./*.js":{"import":{"@abbyy-sdk/document-ai/source":"./src/*.ts","types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}},"./*":{"import":{"@abbyy-sdk/document-ai/source":"./src/*.ts","types":"./dist/esm/*.d.ts","default":"./dist/esm/*.js"},"require":{"types":"./dist/commonjs/*.d.ts","default":"./dist/commonjs/*.js"}}},"main":"./dist/commonjs/index.js","types":"./dist/commonjs/index.d.ts","module":"./dist/esm/index.js","gitHead":"7acf849ebb4f2880004828b0528e0af81ace6959","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","_id":"@abbyy-sdk/document-ai@0.1.4","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-ujMxVp2CsV/LGFUXlKIb15RA7rnoKU+kifqmzAlq++oQqg4gw09UyCKBV0gOfdJsaX23/SZlQjW6URBhOYLGTA==","shasum":"3608b6b079f666378cd94443cce7b558f0fbc7eb","tarball":"https://registry.npmjs.org/@abbyy-sdk/document-ai/-/document-ai-0.1.4.tgz","fileCount":2460,"unpackedSize":10630038,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCCyEqE/mNWmrQrDfMlxn/vf89L6p88DJiQI8/NQiu3ewIgDQ9ksWDcnYtB1RmUTMMTOXZIfmn1htT7hpHbYzUcqxs="}]},"_npmUser":{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"},"directories":{},"maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/document-ai_0.1.4_1744908778201_0.7270197745974865"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-08T15:55:50.352Z","modified":"2025-04-17T16:52:58.750Z","0.1.0":"2025-04-08T15:55:50.756Z","0.1.1":"2025-04-10T15:49:10.819Z","0.1.2":"2025-04-10T21:51:11.194Z","0.1.3":"2025-04-11T21:07:12.772Z","0.1.4":"2025-04-17T16:52:58.557Z"},"bugs":{"url":"https://github.com/abbyyProduct/document-ai-sdk-typescript/issues"},"author":{"name":"Speakeasy"},"homepage":"https://github.com/abbyyProduct/document-ai-sdk-typescript#readme","repository":{"type":"git","url":"git+https://github.com/abbyyProduct/document-ai-sdk-typescript.git"},"description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.","maintainers":[{"name":"larsmikkelsen","email":"lars.mikkelsen@abbyy.com"},{"name":"jaredhagen-abbyy","email":"jared.hagen@abbyy.com"}],"readme":"# @abbyy-sdk/document-ai\n\nDeveloper-friendly & type-safe Typescript SDK specifically catered to leverage *@abbyy-sdk/document-ai* API.\n\n<div align=\"left\">\n    <a href=\"https://www.speakeasy.com/?utm_source=@abbyy-sdk/document-ai&utm_campaign=typescript\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n    <a href=\"https://opensource.org/licenses/MIT\">\n        <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n    </a>\n</div>\n\n<!-- Start Summary [summary] -->\n## Summary\n\nDocument AI API: A modern, simple, and easy-to-integrate OCR and document processing API service\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [@abbyy-sdk/document-ai](#abbyy-sdkdocument-ai)\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  * [Pagination](#pagination)\n  * [Retries](#retries)\n  * [Error Handling](#error-handling)\n  * [Server Selection](#server-selection)\n  * [Custom HTTP Client](#custom-http-client)\n  * [Debugging](#debugging)\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 @abbyy-sdk/document-ai\n```\n\n### PNPM\n\n```bash\npnpm add @abbyy-sdk/document-ai\n```\n\n### Bun\n\n```bash\nbun add @abbyy-sdk/document-ai\n```\n\n### Yarn\n\n```bash\nyarn add @abbyy-sdk/document-ai zod\n\n# Note that Yarn does not install peer dependencies automatically. You will need\n# to install zod as shown above.\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\n```typescript\nimport { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\n  });\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\n}\n\nrun();\n\n```\n<!-- End 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` | http | HTTP Bearer | `DOCUMENTAI_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 { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\n  });\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\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\n### [documents](docs/sdks/documents/README.md)\n\n* [list](docs/sdks/documents/README.md#list) - List Documents\n* [delete](docs/sdks/documents/README.md#delete) - Delete Document\n\n### [models](docs/sdks/models/README.md)\n\n\n#### [models.airWaybill](docs/sdks/airwaybill/README.md)\n\n* [beginFieldExtraction](docs/sdks/airwaybill/README.md#beginfieldextraction) - Begin Air Waybill Field Extraction\n* [getExtractedFields](docs/sdks/airwaybill/README.md#getextractedfields) - Get Air Waybill Fields\n\n#### [models.arrivalNotice](docs/sdks/arrivalnotice/README.md)\n\n* [beginFieldExtraction](docs/sdks/arrivalnotice/README.md#beginfieldextraction) - Begin Arrival Notice Field Extraction\n* [getExtractedFields](docs/sdks/arrivalnotice/README.md#getextractedfields) - Get Arrival Notice Fields\n\n#### [models.bankStatement](docs/sdks/bankstatement/README.md)\n\n* [beginFieldExtraction](docs/sdks/bankstatement/README.md#beginfieldextraction) - Begin Bank Statement Field Extraction\n* [getExtractedFields](docs/sdks/bankstatement/README.md#getextractedfields) - Get Bank Statement Fields\n\n#### [models.basicContract](docs/sdks/basiccontract/README.md)\n\n* [beginFieldExtraction](docs/sdks/basiccontract/README.md#beginfieldextraction) - Begin Basic Contract Field Extraction\n* [getExtractedFields](docs/sdks/basiccontract/README.md#getextractedfields) - Get Basic Contract Fields\n\n#### [models.billOfLading](docs/sdks/billoflading/README.md)\n\n* [beginFieldExtraction](docs/sdks/billoflading/README.md#beginfieldextraction) - Begin Bill Of Lading Field Extraction\n* [getExtractedFields](docs/sdks/billoflading/README.md#getextractedfields) - Get Bill Of Lading Fields\n\n#### [models.brokerageStatement](docs/sdks/brokeragestatement/README.md)\n\n* [beginFieldExtraction](docs/sdks/brokeragestatement/README.md#beginfieldextraction) - Begin Brokerage Statement Field Extraction\n* [getExtractedFields](docs/sdks/brokeragestatement/README.md#getextractedfields) - Get Brokerage Statement Fields\n\n#### [models.certificateOfOrigin](docs/sdks/certificateoforigin/README.md)\n\n* [beginFieldExtraction](docs/sdks/certificateoforigin/README.md#beginfieldextraction) - Begin Certificate Of Origin Field Extraction\n* [getExtractedFields](docs/sdks/certificateoforigin/README.md#getextractedfields) - Get Certificate Of Origin Fields\n\n#### [models.commercialInvoice](docs/sdks/commercialinvoice/README.md)\n\n* [beginFieldExtraction](docs/sdks/commercialinvoice/README.md#beginfieldextraction) - Begin Commercial Invoice Field Extraction\n* [getExtractedFields](docs/sdks/commercialinvoice/README.md#getextractedfields) - Get Commercial Invoice Fields\n\n#### [models.customsDeclaration](docs/sdks/customsdeclaration/README.md)\n\n* [beginFieldExtraction](docs/sdks/customsdeclaration/README.md#beginfieldextraction) - Begin Customs Declaration Field Extraction\n* [getExtractedFields](docs/sdks/customsdeclaration/README.md#getextractedfields) - Get Customs Declaration Fields\n\n#### [models.dangerousGoodsDeclaration](docs/sdks/dangerousgoodsdeclaration/README.md)\n\n* [beginFieldExtraction](docs/sdks/dangerousgoodsdeclaration/README.md#beginfieldextraction) - Begin Dangerous Goods Declaration Field Extraction\n* [getExtractedFields](docs/sdks/dangerousgoodsdeclaration/README.md#getextractedfields) - Get Dangerous Goods Declaration Fields\n\n#### [models.deliveryNote](docs/sdks/deliverynote/README.md)\n\n* [beginFieldExtraction](docs/sdks/deliverynote/README.md#beginfieldextraction) - Begin Delivery Note Field Extraction\n* [getExtractedFields](docs/sdks/deliverynote/README.md#getextractedfields) - Get Delivery Note Fields\n\n#### [models.documentConversion](docs/sdks/documentconversion/README.md)\n\n* [beginConversion](docs/sdks/documentconversion/README.md#beginconversion) - Begin Document Conversion\n* [getConversion](docs/sdks/documentconversion/README.md#getconversion) - Get Conversion\n* [downloadConvertedDocument](docs/sdks/documentconversion/README.md#downloadconverteddocument) - Download Converted Document\n\n#### [models.hotelInvoice](docs/sdks/hotelinvoice/README.md)\n\n* [beginFieldExtraction](docs/sdks/hotelinvoice/README.md#beginfieldextraction) - Begin Hotel Invoice Field Extraction\n* [getExtractedFields](docs/sdks/hotelinvoice/README.md#getextractedfields) - Get Hotel Invoice Fields\n\n#### [models.imageToText](docs/sdks/imagetotext/README.md)\n\n* [beginTextExtraction](docs/sdks/imagetotext/README.md#begintextextraction) - Begin Image To Text Extraction\n* [getExtractedText](docs/sdks/imagetotext/README.md#getextractedtext) - Get Extracted Text\n\n#### [models.internationalConsignmentNote](docs/sdks/internationalconsignmentnote/README.md)\n\n* [beginFieldExtraction](docs/sdks/internationalconsignmentnote/README.md#beginfieldextraction) - Begin International Consignment Note Field Extraction\n* [getExtractedFields](docs/sdks/internationalconsignmentnote/README.md#getextractedfields) - Get International Consignment Note Fields\n\n#### [models.invoice](docs/sdks/invoice/README.md)\n\n* [beginFieldExtraction](docs/sdks/invoice/README.md#beginfieldextraction) - Begin Invoice Field Extraction\n* [getExtractedFields](docs/sdks/invoice/README.md#getextractedfields) - Get Invoice Fields\n\n#### [models.packingList](docs/sdks/packinglist/README.md)\n\n* [beginFieldExtraction](docs/sdks/packinglist/README.md#beginfieldextraction) - Begin Packing List Field Extraction\n* [getExtractedFields](docs/sdks/packinglist/README.md#getextractedfields) - Get Packing List Fields\n\n#### [models.personalEarningsStatement](docs/sdks/personalearningsstatement/README.md)\n\n* [beginFieldExtraction](docs/sdks/personalearningsstatement/README.md#beginfieldextraction) - Begin Personal Earnings Statement Field Extraction\n* [getExtractedFields](docs/sdks/personalearningsstatement/README.md#getextractedfields) - Get Personal Earnings Statement Fields\n\n#### [models.purchaseOrder](docs/sdks/purchaseorder/README.md)\n\n* [beginFieldExtraction](docs/sdks/purchaseorder/README.md#beginfieldextraction) - Begin Purchase Order Field Extraction\n* [getExtractedFields](docs/sdks/purchaseorder/README.md#getextractedfields) - Get Purchase Order Fields\n\n#### [models.receipt](docs/sdks/receipt/README.md)\n\n* [beginFieldExtraction](docs/sdks/receipt/README.md#beginfieldextraction) - Begin Receipt Field Extraction\n* [getExtractedFields](docs/sdks/receipt/README.md#getextractedfields) - Get Receipt Fields\n\n#### [models.remittanceAdvice](docs/sdks/remittanceadvice/README.md)\n\n* [beginFieldExtraction](docs/sdks/remittanceadvice/README.md#beginfieldextraction) - Begin Remittance Advice Field Extraction\n* [getExtractedFields](docs/sdks/remittanceadvice/README.md#getextractedfields) - Get Remittance Advice Fields\n\n#### [models.seaWaybill](docs/sdks/seawaybill/README.md)\n\n* [beginFieldExtraction](docs/sdks/seawaybill/README.md#beginfieldextraction) - Begin Sea Waybill Field Extraction\n* [getExtractedFields](docs/sdks/seawaybill/README.md#getextractedfields) - Get Sea Waybill Fields\n\n#### [models.taxiReceipt](docs/sdks/taxireceipt/README.md)\n\n* [beginFieldExtraction](docs/sdks/taxireceipt/README.md#beginfieldextraction) - Begin Taxi Receipt Field Extraction\n* [getExtractedFields](docs/sdks/taxireceipt/README.md#getextractedfields) - Get Taxi Receipt Fields\n\n#### [models.usForm1040](docs/sdks/usform1040/README.md)\n\n* [beginFieldExtraction](docs/sdks/usform1040/README.md#beginfieldextraction) - Begin US Form 1040 Field Extraction\n* [getExtractedFields](docs/sdks/usform1040/README.md#getextractedfields) - Get US Form 1040 Fields\n\n#### [models.usFormW2](docs/sdks/usformw2/README.md)\n\n* [beginFieldExtraction](docs/sdks/usformw2/README.md#beginfieldextraction) - Begin US Form W2 Field Extraction\n* [getExtractedFields](docs/sdks/usformw2/README.md#getextractedfields) - Get US Form W2 Fields\n\n#### [models.utilityBill](docs/sdks/utilitybill/README.md)\n\n* [beginFieldExtraction](docs/sdks/utilitybill/README.md#beginfieldextraction) - Begin Utility Bill Field Extraction\n* [getExtractedFields](docs/sdks/utilitybill/README.md#getextractedfields) - Get Utility Bill Fields\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- [`documentsDelete`](docs/sdks/documents/README.md#delete) - Delete Document\n- [`documentsList`](docs/sdks/documents/README.md#list) - List Documents\n- [`modelsAirWaybillBeginFieldExtraction`](docs/sdks/airwaybill/README.md#beginfieldextraction) - Begin Air Waybill Field Extraction\n- [`modelsAirWaybillGetExtractedFields`](docs/sdks/airwaybill/README.md#getextractedfields) - Get Air Waybill Fields\n- [`modelsArrivalNoticeBeginFieldExtraction`](docs/sdks/arrivalnotice/README.md#beginfieldextraction) - Begin Arrival Notice Field Extraction\n- [`modelsArrivalNoticeGetExtractedFields`](docs/sdks/arrivalnotice/README.md#getextractedfields) - Get Arrival Notice Fields\n- [`modelsBankStatementBeginFieldExtraction`](docs/sdks/bankstatement/README.md#beginfieldextraction) - Begin Bank Statement Field Extraction\n- [`modelsBankStatementGetExtractedFields`](docs/sdks/bankstatement/README.md#getextractedfields) - Get Bank Statement Fields\n- [`modelsBasicContractBeginFieldExtraction`](docs/sdks/basiccontract/README.md#beginfieldextraction) - Begin Basic Contract Field Extraction\n- [`modelsBasicContractGetExtractedFields`](docs/sdks/basiccontract/README.md#getextractedfields) - Get Basic Contract Fields\n- [`modelsBillOfLadingBeginFieldExtraction`](docs/sdks/billoflading/README.md#beginfieldextraction) - Begin Bill Of Lading Field Extraction\n- [`modelsBillOfLadingGetExtractedFields`](docs/sdks/billoflading/README.md#getextractedfields) - Get Bill Of Lading Fields\n- [`modelsBrokerageStatementBeginFieldExtraction`](docs/sdks/brokeragestatement/README.md#beginfieldextraction) - Begin Brokerage Statement Field Extraction\n- [`modelsBrokerageStatementGetExtractedFields`](docs/sdks/brokeragestatement/README.md#getextractedfields) - Get Brokerage Statement Fields\n- [`modelsCertificateOfOriginBeginFieldExtraction`](docs/sdks/certificateoforigin/README.md#beginfieldextraction) - Begin Certificate Of Origin Field Extraction\n- [`modelsCertificateOfOriginGetExtractedFields`](docs/sdks/certificateoforigin/README.md#getextractedfields) - Get Certificate Of Origin Fields\n- [`modelsCommercialInvoiceBeginFieldExtraction`](docs/sdks/commercialinvoice/README.md#beginfieldextraction) - Begin Commercial Invoice Field Extraction\n- [`modelsCommercialInvoiceGetExtractedFields`](docs/sdks/commercialinvoice/README.md#getextractedfields) - Get Commercial Invoice Fields\n- [`modelsCustomsDeclarationBeginFieldExtraction`](docs/sdks/customsdeclaration/README.md#beginfieldextraction) - Begin Customs Declaration Field Extraction\n- [`modelsCustomsDeclarationGetExtractedFields`](docs/sdks/customsdeclaration/README.md#getextractedfields) - Get Customs Declaration Fields\n- [`modelsDangerousGoodsDeclarationBeginFieldExtraction`](docs/sdks/dangerousgoodsdeclaration/README.md#beginfieldextraction) - Begin Dangerous Goods Declaration Field Extraction\n- [`modelsDangerousGoodsDeclarationGetExtractedFields`](docs/sdks/dangerousgoodsdeclaration/README.md#getextractedfields) - Get Dangerous Goods Declaration Fields\n- [`modelsDeliveryNoteBeginFieldExtraction`](docs/sdks/deliverynote/README.md#beginfieldextraction) - Begin Delivery Note Field Extraction\n- [`modelsDeliveryNoteGetExtractedFields`](docs/sdks/deliverynote/README.md#getextractedfields) - Get Delivery Note Fields\n- [`modelsDocumentConversionBeginConversion`](docs/sdks/documentconversion/README.md#beginconversion) - Begin Document Conversion\n- [`modelsDocumentConversionDownloadConvertedDocument`](docs/sdks/documentconversion/README.md#downloadconverteddocument) - Download Converted Document\n- [`modelsDocumentConversionGetConversion`](docs/sdks/documentconversion/README.md#getconversion) - Get Conversion\n- [`modelsHotelInvoiceBeginFieldExtraction`](docs/sdks/hotelinvoice/README.md#beginfieldextraction) - Begin Hotel Invoice Field Extraction\n- [`modelsHotelInvoiceGetExtractedFields`](docs/sdks/hotelinvoice/README.md#getextractedfields) - Get Hotel Invoice Fields\n- [`modelsImageToTextBeginTextExtraction`](docs/sdks/imagetotext/README.md#begintextextraction) - Begin Image To Text Extraction\n- [`modelsImageToTextGetExtractedText`](docs/sdks/imagetotext/README.md#getextractedtext) - Get Extracted Text\n- [`modelsInternationalConsignmentNoteBeginFieldExtraction`](docs/sdks/internationalconsignmentnote/README.md#beginfieldextraction) - Begin International Consignment Note Field Extraction\n- [`modelsInternationalConsignmentNoteGetExtractedFields`](docs/sdks/internationalconsignmentnote/README.md#getextractedfields) - Get International Consignment Note Fields\n- [`modelsInvoiceBeginFieldExtraction`](docs/sdks/invoice/README.md#beginfieldextraction) - Begin Invoice Field Extraction\n- [`modelsInvoiceGetExtractedFields`](docs/sdks/invoice/README.md#getextractedfields) - Get Invoice Fields\n- [`modelsPackingListBeginFieldExtraction`](docs/sdks/packinglist/README.md#beginfieldextraction) - Begin Packing List Field Extraction\n- [`modelsPackingListGetExtractedFields`](docs/sdks/packinglist/README.md#getextractedfields) - Get Packing List Fields\n- [`modelsPersonalEarningsStatementBeginFieldExtraction`](docs/sdks/personalearningsstatement/README.md#beginfieldextraction) - Begin Personal Earnings Statement Field Extraction\n- [`modelsPersonalEarningsStatementGetExtractedFields`](docs/sdks/personalearningsstatement/README.md#getextractedfields) - Get Personal Earnings Statement Fields\n- [`modelsPurchaseOrderBeginFieldExtraction`](docs/sdks/purchaseorder/README.md#beginfieldextraction) - Begin Purchase Order Field Extraction\n- [`modelsPurchaseOrderGetExtractedFields`](docs/sdks/purchaseorder/README.md#getextractedfields) - Get Purchase Order Fields\n- [`modelsReceiptBeginFieldExtraction`](docs/sdks/receipt/README.md#beginfieldextraction) - Begin Receipt Field Extraction\n- [`modelsReceiptGetExtractedFields`](docs/sdks/receipt/README.md#getextractedfields) - Get Receipt Fields\n- [`modelsRemittanceAdviceBeginFieldExtraction`](docs/sdks/remittanceadvice/README.md#beginfieldextraction) - Begin Remittance Advice Field Extraction\n- [`modelsRemittanceAdviceGetExtractedFields`](docs/sdks/remittanceadvice/README.md#getextractedfields) - Get Remittance Advice Fields\n- [`modelsSeaWaybillBeginFieldExtraction`](docs/sdks/seawaybill/README.md#beginfieldextraction) - Begin Sea Waybill Field Extraction\n- [`modelsSeaWaybillGetExtractedFields`](docs/sdks/seawaybill/README.md#getextractedfields) - Get Sea Waybill Fields\n- [`modelsTaxiReceiptBeginFieldExtraction`](docs/sdks/taxireceipt/README.md#beginfieldextraction) - Begin Taxi Receipt Field Extraction\n- [`modelsTaxiReceiptGetExtractedFields`](docs/sdks/taxireceipt/README.md#getextractedfields) - Get Taxi Receipt Fields\n- [`modelsUsForm1040BeginFieldExtraction`](docs/sdks/usform1040/README.md#beginfieldextraction) - Begin US Form 1040 Field Extraction\n- [`modelsUsForm1040GetExtractedFields`](docs/sdks/usform1040/README.md#getextractedfields) - Get US Form 1040 Fields\n- [`modelsUsFormW2BeginFieldExtraction`](docs/sdks/usformw2/README.md#beginfieldextraction) - Begin US Form W2 Field Extraction\n- [`modelsUsFormW2GetExtractedFields`](docs/sdks/usformw2/README.md#getextractedfields) - Get US Form W2 Fields\n- [`modelsUtilityBillBeginFieldExtraction`](docs/sdks/utilitybill/README.md#beginfieldextraction) - Begin Utility Bill Field Extraction\n- [`modelsUtilityBillGetExtractedFields`](docs/sdks/utilitybill/README.md#getextractedfields) - Get Utility Bill Fields\n\n</details>\n<!-- End Standalone functions [standalone-funcs] -->\n\n<!-- Start Pagination [pagination] -->\n## Pagination\n\nSome of the endpoints in this SDK support pagination. To use pagination, you\nmake your SDK calls as usual, but the returned response object will also be an\nasync iterable that can be consumed using the [`for await...of`][for-await-of]\nsyntax.\n\n[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of\n\nHere's an example of one such pagination call:\n\n```typescript\nimport { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\n  });\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\n}\n\nrun();\n\n```\n<!-- End Pagination [pagination] -->\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 { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\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  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\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 { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\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[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\n  });\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\n}\n\nrun();\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nSome methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:\n\n| Error Type                  | Status Code | Content Type     |\n| --------------------------- | ----------- | ---------------- |\n| errors.BadRequestError      | 400         | application/json |\n| errors.UnauthorizedError    | 401         | application/json |\n| errors.TooManyRequestsError | 429         | application/json |\n| errors.InternalServerError  | 500         | application/json |\n| errors.APIError             | 4XX, 5XX    | \\*/\\*            |\n\nIf the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.\n\n```typescript\nimport { DocumentAi } from \"@abbyy-sdk/document-ai\";\nimport {\n  BadRequestError,\n  InternalServerError,\n  SDKValidationError,\n  TooManyRequestsError,\n  UnauthorizedError,\n} from \"@abbyy-sdk/document-ai/models/errors\";\n\nconst documentAi = new DocumentAi({\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  let result;\n  try {\n    result = await documentAi.documents.list({\n      cursor: \"xyz\",\n    });\n\n    for await (const page of result) {\n      // Handle the page\n      console.log(page);\n    }\n  } catch (err) {\n    switch (true) {\n      // The server response does not match the expected SDK schema\n      case (err instanceof SDKValidationError): {\n        // Pretty-print will provide a human-readable multi-line error message\n        console.error(err.pretty());\n        // Raw value may also be inspected\n        console.error(err.rawValue);\n        return;\n      }\n      case (err instanceof BadRequestError): {\n        // Handle err.data$: BadRequestErrorData\n        console.error(err);\n        return;\n      }\n      case (err instanceof UnauthorizedError): {\n        // Handle err.data$: UnauthorizedErrorData\n        console.error(err);\n        return;\n      }\n      case (err instanceof TooManyRequestsError): {\n        // Handle err.data$: TooManyRequestsErrorData\n        console.error(err);\n        return;\n      }\n      case (err instanceof InternalServerError): {\n        // Handle err.data$: InternalServerErrorData\n        console.error(err);\n        return;\n      }\n      default: {\n        // Other errors such as network errors, see HTTPClientErrors for more details\n        throw err;\n      }\n    }\n  }\n}\n\nrun();\n\n```\n\nValidation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.\n\nIn some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:\n\n| HTTP Client Error                                    | Description                                          |\n| ---------------------------------------------------- | ---------------------------------------------------- |\n| RequestAbortedError                                  | HTTP request was aborted by the client               |\n| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |\n| ConnectionError                                      | HTTP client was unable to make a request to a server |\n| InvalidRequestError                                  | Any input used to create a request is invalid        |\n| UnexpectedClientError                                | Unrecognised or unexpected error                     |\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 { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst documentAi = new DocumentAi({\n  serverURL: \"https://api.abbyy.com/document-ai\",\n  apiKeyAuth: process.env[\"DOCUMENTAI_API_KEY_AUTH\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await documentAi.documents.list({\n    cursor: \"xyz\",\n  });\n\n  for await (const page of result) {\n    // Handle the page\n    console.log(page);\n  }\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 use the `\"beforeRequest\"` hook to to add a\ncustom header and a timeout to requests and how to use the `\"requestError\"` hook\nto log errors:\n\n```typescript\nimport { DocumentAi } from \"@abbyy-sdk/document-ai\";\nimport { HTTPClient } from \"@abbyy-sdk/document-ai/lib/http\";\n\nconst httpClient = new HTTPClient({\n  // fetcher takes a function that has the same signature as native `fetch`.\n  fetcher: (request) => {\n    return fetch(request);\n  }\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 DocumentAi({ 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 { DocumentAi } from \"@abbyy-sdk/document-ai\";\n\nconst sdk = new DocumentAi({ debugLogger: console });\n```\n\nYou can also enable a default debug logger by setting an environment variable `DOCUMENTAI_DEBUG` to true.\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n","readmeFilename":"README.md"}