{"_id":"@authlete/arena","_rev":"3-361158c8276c08af0405f0702eaa400e","name":"@authlete/arena","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.3":{"name":"@authlete/arena","version":"0.1.3","author":{"name":"Speakeasy"},"_id":"@authlete/arena@0.1.3","maintainers":[{"name":"shariqnazr222","email":"shariqnzr@gmail.com"},{"name":"authlete-ops","email":"ops@authlete.com"}],"dist":{"shasum":"5fd11e3589bec78af8324661fc2bb48f561c4693","tarball":"https://registry.npmjs.org/@authlete/arena/-/arena-0.1.3.tgz","fileCount":1053,"integrity":"sha512-zwS/mMpVWKMQk3Hohki6gmoPz8NqkFZAe0LJCKdLnoB7UA/PqxEVatqlIv/MWYaDyE3/Of4h0IeJ275MwcNJJQ==","signatures":[{"sig":"MEYCIQC0yrQD8EIrWRAT7oml6VwFJa/3PVXp5Q/fts83msMr8AIhALl91xa87+rElku7iFxzW3/R9H9DiJUIELXhRUDsEbQO","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6551876},"main":"./esm/index.js","type":"module","types":"./esm/index.d.ts","exports":{".":{"types":"./esm/index.d.ts","source":"./src/index.ts","default":"./esm/index.js"},"./*":{"types":"./esm/*.d.ts","source":"./src/*.ts","default":"./esm/*.js"},"./*.js":{"types":"./esm/*.d.ts","source":"./src/*.ts","default":"./esm/*.js"},"./types":{"types":"./esm/types/index.d.ts","source":"./src/types/index.ts","default":"./esm/types/index.js"},"./models":{"types":"./esm/models/index.d.ts","source":"./src/models/index.ts","default":"./esm/models/index.js"},"./package.json":"./package.json","./models/errors":{"types":"./esm/models/errors/index.d.ts","source":"./src/models/errors/index.ts","default":"./esm/models/errors/index.js"},"./models/operations":{"types":"./esm/models/operations/index.d.ts","source":"./src/models/operations/index.ts","default":"./esm/models/operations/index.js"}},"gitHead":"169303fd563da01cb0b6f2243e97429fe607d636","scripts":{"lint":"oxlint --max-warnings=0 --deny-warnings --no-error-on-unmatched-pattern src","build":"tsgo","prepublishOnly":"npm run build"},"_npmUser":{"name":"authlete-ops","email":"ops@authlete.com"},"_npmVersion":"10.9.2","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *authlete-arena* API.","directories":{},"sideEffects":false,"_nodeVersion":"22.17.0","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"oxlint":"^1.60.0","typescript":"~5.8.3","@typescript/native-preview":"7.0.0-dev.20260302.1"},"_npmOperationalInternal":{"tmp":"tmp/arena_0.1.3_1788865699027_0.4004888885468749","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@authlete/arena","version":"0.1.4","author":{"name":"Speakeasy"},"_id":"@authlete/arena@0.1.4","maintainers":[{"name":"shariqnazr222","email":"shariqnzr@gmail.com"},{"name":"authlete-ops","email":"ops@authlete.com"}],"dist":{"shasum":"82de1084b256e3efbe7d3eb5326920b09eae437d","tarball":"https://registry.npmjs.org/@authlete/arena/-/arena-0.1.4.tgz","fileCount":776,"integrity":"sha512-Tw0b0KRjXLIJb3c62ACb1FJhzVQ2t4VvcJSV4yGGWzVjXYvHxhAWuUJzopOPcgNES0mXJmg/MSRc2snyZo4/IQ==","signatures":[{"sig":"MEQCIHXHUMrQ9Bubf21iwQmzKu4Nd2uzvCQUL8lsewsbYOedAiBVBgoDehNzRbRAs9oDVA1sOo0GKAlu06QxqwMg9vagdg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":3402194},"main":"./esm/index.js","type":"module","types":"./esm/index.d.ts","exports":{".":{"types":"./esm/index.d.ts","source":"./src/index.ts","default":"./esm/index.js"},"./*":{"types":"./esm/*.d.ts","source":"./src/*.ts","default":"./esm/*.js"},"./*.js":{"types":"./esm/*.d.ts","source":"./src/*.ts","default":"./esm/*.js"},"./types":{"types":"./esm/types/index.d.ts","source":"./src/types/index.ts","default":"./esm/types/index.js"},"./models":{"types":"./esm/models/index.d.ts","source":"./src/models/index.ts","default":"./esm/models/index.js"},"./package.json":"./package.json","./models/errors":{"types":"./esm/models/errors/index.d.ts","source":"./src/models/errors/index.ts","default":"./esm/models/errors/index.js"},"./models/operations":{"types":"./esm/models/operations/index.d.ts","source":"./src/models/operations/index.ts","default":"./esm/models/operations/index.js"}},"gitHead":"7d0c07726719e303c48faebefa647aed3e5787dc","scripts":{"lint":"oxlint --max-warnings=0 --deny-warnings --no-error-on-unmatched-pattern src","build":"tsgo","prepublishOnly":"npm run build"},"_npmUser":{"name":"authlete-ops","email":"ops@authlete.com"},"_npmVersion":"11.19.0","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *authlete-arena* API.","directories":{},"sideEffects":false,"_nodeVersion":"24.20.0","dependencies":{"zod":"^3.25.65 || ^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"oxlint":"^1.60.0","typescript":"~5.8.3","@typescript/native-preview":"7.0.0-dev.20260302.1"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/arena_0.1.4_1788866323715_0.7704671238998688","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@authlete/arena","version":"0.2.0","author":{"name":"Speakeasy"},"type":"module","main":"./esm/index.js","exports":{".":{"source":"./src/index.ts","types":"./esm/index.d.ts","default":"./esm/index.js"},"./package.json":"./package.json","./types":{"source":"./src/types/index.ts","types":"./esm/types/index.d.ts","default":"./esm/types/index.js"},"./models/errors":{"source":"./src/models/errors/index.ts","types":"./esm/models/errors/index.d.ts","default":"./esm/models/errors/index.js"},"./models":{"source":"./src/models/index.ts","types":"./esm/models/index.d.ts","default":"./esm/models/index.js"},"./models/operations":{"source":"./src/models/operations/index.ts","types":"./esm/models/operations/index.d.ts","default":"./esm/models/operations/index.js"},"./*.js":{"source":"./src/*.ts","types":"./esm/*.d.ts","default":"./esm/*.js"},"./*":{"source":"./src/*.ts","types":"./esm/*.d.ts","default":"./esm/*.js"}},"sideEffects":false,"scripts":{"lint":"oxlint --max-warnings=0 --deny-warnings --no-error-on-unmatched-pattern src","build":"tsgo","prepublishOnly":"npm run build"},"peerDependencies":{},"devDependencies":{"@typescript/native-preview":"7.0.0-dev.20260302.1","oxlint":"^1.60.0","typescript":"~5.8.3"},"dependencies":{"zod":"^3.25.65 || ^4.0.0"},"gitHead":"b85c99ec127125ca69791339a12189e5bdcedab1","types":"./esm/index.d.ts","_id":"@authlete/arena@0.2.0","description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *authlete-arena* API.","_nodeVersion":"24.20.0","_npmVersion":"11.19.0","dist":{"integrity":"sha512-uk0Jp9sptLlqesNogHXDoaPyHkALr3zjC5+nq+T/8XiWwiznwYSBySPolBSY7wtLFA6NVfN4ByrGZTxN8qkxXw==","shasum":"17078fb05acc66ec7a302d7cbd468f867bf2e692","tarball":"https://registry.npmjs.org/@authlete/arena/-/arena-0.2.0.tgz","fileCount":776,"unpackedSize":3626125,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCCtOs+UkfvJGBgcJC6TFSqGrkMWwIeDNwh1s+PwJMneAIgb/AjddNNde65oMMLYcgR5RPb0Au1wpb6UNK9b5RTHdw="}]},"_npmUser":{"name":"authlete-ops","email":"ops@authlete.com"},"directories":{},"maintainers":[{"name":"shariqnazr222","email":"shariqnzr@gmail.com"},{"name":"authlete-ops","email":"ops@authlete.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/arena_0.2.0_1788872776503_0.5487745128899209"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-08T11:08:18.760Z","modified":"2026-09-08T13:06:16.953Z","0.1.3":"2026-09-08T11:08:19.203Z","0.1.4":"2026-09-08T11:18:44.035Z","0.2.0":"2026-09-08T13:06:16.662Z"},"author":{"name":"Speakeasy"},"description":"Developer-friendly & type-safe Typescript SDK specifically catered to leverage *authlete-arena* API.","maintainers":[{"name":"shariqnazr222","email":"shariqnzr@gmail.com"},{"name":"authlete-ops","email":"ops@authlete.com"}],"readme":"# authlete-arena\n\nDeveloper-friendly & type-safe Typescript SDK specifically catered to leverage *authlete-arena* API.\n\n[](https://www.speakeasy.com/?utm_source=authlete-arena&utm_campaign=typescript)\n[](https://opensource.org/licenses/MIT)\n\n\n
\n> [!IMPORTANT]\n> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/authlete/sdk-workspace). Delete this section before > publishing to a package manager.\n\n\n## Summary\n\nArena Core Server: Web APIs to aid developers to implement the standard specifications related to Shared Signals.\n\n\n\n## Table of Contents\n\n* [authlete-arena](#authlete-arena)\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 * [Retries](#retries)\n * [Error Handling](#error-handling)\n * [Custom HTTP Client](#custom-http-client)\n * [Debugging](#debugging)\n* [Development](#development)\n * [Maturity](#maturity)\n * [Contributions](#contributions)\n\n\n\n\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 @authlete/arena\n```\n\n### PNPM\n\n```bash\npnpm add @authlete/arena\n```\n\n### Bun\n\n```bash\nbun add @authlete/arena\n```\n\n### Yarn\n\n```bash\nyarn add @authlete/arena\n```\n\n> [!NOTE]\n> This package is published as an ES Module (ESM) only. For applications using\n> CommonJS, use `await import(\"@authlete/arena\")` to import and use this package.\n\n\n\n## Requirements\n\nFor supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).\n\n\n\n## SDK Example Usage\n\n### Example\n\n```typescript\nimport { Arena } from \"@authlete/arena\";\n\nconst arena = new Arena({\n serverURL: \"https://api.example.com\",\n});\n\nasync function run() {\n const result = await arena.metadata.getProtectedResource({\n xFapiInteractionId: \"1152537a-7f40-4405-860e-0fbdc75837b3\",\n });\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security schemes globally:\n\n| Name | Type | Scheme | Environment Variable |\n| -------- | ------ | ----------- | -------------------- |\n| `bearer` | http | HTTP Bearer | `ARENA_BEARER` |\n| `dpop` | apiKey | API key | `ARENA_DPOP` |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:\n```typescript\nimport { Arena } from \"@authlete/arena\";\n\nconst arena = new Arena({\n serverURL: \"https://api.example.com\",\n security: {\n bearer: process.env[\"ARENA_BEARER\"] ?? \"\",\n },\n});\n\nasync function run() {\n const result = await arena.metadata.getProtectedResource({\n xFapiInteractionId: \"1152537a-7f40-4405-860e-0fbdc75837b3\",\n });\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\n## Available Resources and Operations\n\n\nAvailable methods
\n\n### [Delegate](docs/sdks/delegate/README.md)\n\n* [jwks](docs/sdks/delegate/README.md#jwks) - JWK Set Document Endpoint\n\n#### [Delegate.Status](docs/sdks/status/README.md)\n\n* [get](docs/sdks/status/README.md#get) - Stream Status Read (HTTP GET to the status endpoint)\n* [update](docs/sdks/status/README.md#update) - Stream Status Update (HTTP POST to the status endpoint)\n\n#### [Delegate.Streams](docs/sdks/delegatestreams/README.md)\n\n* [create](docs/sdks/delegatestreams/README.md#create) - Stream Create (HTTP POST to the configuration endpoint)\n* [get](docs/sdks/delegatestreams/README.md#get) - Stream Read (HTTP GET to the configuration endpoint)\n* [update](docs/sdks/delegatestreams/README.md#update) - Stream Update (HTTP PATCH to the configuration endpoint)\n* [replace](docs/sdks/delegatestreams/README.md#replace) - Stream Replace (HTTP PUT to the configuration endpoint)\n* [delete](docs/sdks/delegatestreams/README.md#delete) - Stream Delete (HTTP DELETE to the configuration endpoint)\n* [verify](docs/sdks/delegatestreams/README.md#verify) - Stream Verify (HTTP POST to the verification endpoint)\n* [poll](docs/sdks/delegatestreams/README.md#poll) - Stream Poll (HTTP POST to the poll endpoint)\n\n#### [Delegate.Subjects](docs/sdks/subjects/README.md)\n\n* [add](docs/sdks/subjects/README.md#add) - Stream Subject Add (HTTP POST to the add subject endpoint)\n* [remove](docs/sdks/subjects/README.md#remove) - Stream Subject Remove (HTTP POST to the remove subject endpoint)\n* [list](docs/sdks/subjects/README.md#list) - Stream Subject List (HTTP GET to the list subjects endpoint)\n\n#### [Delegate.WellKnown](docs/sdks/wellknown/README.md)\n\n* [protectedResource](docs/sdks/wellknown/README.md#protectedresource) - Protected Resource Metadata Endpoint (/.well-known/oauth-protected-resource)\n* [ssfConfiguration](docs/sdks/wellknown/README.md#ssfconfiguration) - Transmitter Metadata Endpoint (/.well-known/ssf-configuration)\n\n### [Events](docs/sdks/events/README.md)\n\n* [register](docs/sdks/events/README.md#register) - Register an event.\n* [list](docs/sdks/events/README.md#list) - List stream events.\n* [get](docs/sdks/events/README.md#get) - Retrieve information about the event.\n* [delete](docs/sdks/events/README.md#delete) - Delete the event.\n\n### [Health](docs/sdks/health/README.md)\n\n* [database](docs/sdks/health/README.md#database) - Database probe.\n* [liveness](docs/sdks/health/README.md#liveness) - Liveness probe for Kubernetes.\n* [readiness](docs/sdks/health/README.md#readiness) - Readiness probe for Kubernetes.\n* [startup](docs/sdks/health/README.md#startup) - Startup probe for Kubernetes.\n\n### [Metadata](docs/sdks/metadata/README.md)\n\n* [getProtectedResource](docs/sdks/metadata/README.md#getprotectedresource) - OAuth 2.0 Protected Resource Metadata\n* [getJwks](docs/sdks/metadata/README.md#getjwks) - JWK Set Document\n* [getOpenApiDocument](docs/sdks/metadata/README.md#getopenapidocument) - Retrieve the OpenAPI document of this web application.\n\n### [Streams](docs/sdks/streams/README.md)\n\n* [list](docs/sdks/streams/README.md#list) - List streams.\n* [get](docs/sdks/streams/README.md#get) - Retrieve information about the stream.\n* [delete](docs/sdks/streams/README.md#delete) - Delete the stream.\n* [verify](docs/sdks/streams/README.md#verify) - Register a verification event into the stream.\n\n### [Transmitters](docs/sdks/transmitters/README.md)\n\n* [create](docs/sdks/transmitters/README.md#create) - Create a transmitter.\n* [get](docs/sdks/transmitters/README.md#get) - Retrieve information about the transmitter.\n* [update](docs/sdks/transmitters/README.md#update) - Update the transmitter.\n* [delete](docs/sdks/transmitters/README.md#delete) - Delete the transmitter.\n* [patch](docs/sdks/transmitters/README.md#patch) - Apply a patch to the transmitter.\n\n \n\n\n\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\n\nAvailable standalone functions
\n\n- [`delegateJwks`](docs/sdks/delegate/README.md#jwks) - JWK Set Document Endpoint\n- [`delegateStatusGet`](docs/sdks/status/README.md#get) - Stream Status Read (HTTP GET to the status endpoint)\n- [`delegateStatusUpdate`](docs/sdks/status/README.md#update) - Stream Status Update (HTTP POST to the status endpoint)\n- [`delegateStreamsCreate`](docs/sdks/delegatestreams/README.md#create) - Stream Create (HTTP POST to the configuration endpoint)\n- [`delegateStreamsDelete`](docs/sdks/delegatestreams/README.md#delete) - Stream Delete (HTTP DELETE to the configuration endpoint)\n- [`delegateStreamsGet`](docs/sdks/delegatestreams/README.md#get) - Stream Read (HTTP GET to the configuration endpoint)\n- [`delegateStreamsPoll`](docs/sdks/delegatestreams/README.md#poll) - Stream Poll (HTTP POST to the poll endpoint)\n- [`delegateStreamsReplace`](docs/sdks/delegatestreams/README.md#replace) - Stream Replace (HTTP PUT to the configuration endpoint)\n- [`delegateStreamsUpdate`](docs/sdks/delegatestreams/README.md#update) - Stream Update (HTTP PATCH to the configuration endpoint)\n- [`delegateStreamsVerify`](docs/sdks/delegatestreams/README.md#verify) - Stream Verify (HTTP POST to the verification endpoint)\n- [`delegateSubjectsAdd`](docs/sdks/subjects/README.md#add) - Stream Subject Add (HTTP POST to the add subject endpoint)\n- [`delegateSubjectsList`](docs/sdks/subjects/README.md#list) - Stream Subject List (HTTP GET to the list subjects endpoint)\n- [`delegateSubjectsRemove`](docs/sdks/subjects/README.md#remove) - Stream Subject Remove (HTTP POST to the remove subject endpoint)\n- [`delegateWellKnownProtectedResource`](docs/sdks/wellknown/README.md#protectedresource) - Protected Resource Metadata Endpoint (/.well-known/oauth-protected-resource)\n- [`delegateWellKnownSsfConfiguration`](docs/sdks/wellknown/README.md#ssfconfiguration) - Transmitter Metadata Endpoint (/.well-known/ssf-configuration)\n- [`eventsDelete`](docs/sdks/events/README.md#delete) - Delete the event.\n- [`eventsGet`](docs/sdks/events/README.md#get) - Retrieve information about the event.\n- [`eventsList`](docs/sdks/events/README.md#list) - List stream events.\n- [`eventsRegister`](docs/sdks/events/README.md#register) - Register an event.\n- [`healthDatabase`](docs/sdks/health/README.md#database) - Database probe.\n- [`healthLiveness`](docs/sdks/health/README.md#liveness) - Liveness probe for Kubernetes.\n- [`healthReadiness`](docs/sdks/health/README.md#readiness) - Readiness probe for Kubernetes.\n- [`healthStartup`](docs/sdks/health/README.md#startup) - Startup probe for Kubernetes.\n- [`metadataGetJwks`](docs/sdks/metadata/README.md#getjwks) - JWK Set Document\n- [`metadataGetOpenApiDocument`](docs/sdks/metadata/README.md#getopenapidocument) - Retrieve the OpenAPI document of this web application.\n- [`metadataGetProtectedResource`](docs/sdks/metadata/README.md#getprotectedresource) - OAuth 2.0 Protected Resource Metadata\n- [`streamsDelete`](docs/sdks/streams/README.md#delete) - Delete the stream.\n- [`streamsGet`](docs/sdks/streams/README.md#get) - Retrieve information about the stream.\n- [`streamsList`](docs/sdks/streams/README.md#list) - List streams.\n- [`streamsVerify`](docs/sdks/streams/README.md#verify) - Register a verification event into the stream.\n- [`transmittersCreate`](docs/sdks/transmitters/README.md#create) - Create a transmitter.\n- [`transmittersDelete`](docs/sdks/transmitters/README.md#delete) - Delete the transmitter.\n- [`transmittersGet`](docs/sdks/transmitters/README.md#get) - Retrieve information about the transmitter.\n- [`transmittersPatch`](docs/sdks/transmitters/README.md#patch) - Apply a patch to the transmitter.\n- [`transmittersUpdate`](docs/sdks/transmitters/README.md#update) - Update the transmitter.\n\n \n\n\n\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 { Arena } from \"@authlete/arena\";\n\nconst arena = new Arena({\n serverURL: \"https://api.example.com\",\n});\n\nasync function run() {\n const result = await arena.metadata.getProtectedResource({\n xFapiInteractionId: \"1152537a-7f40-4405-860e-0fbdc75837b3\",\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 { Arena } from \"@authlete/arena\";\n\nconst arena = new Arena({\n serverURL: \"https://api.example.com\",\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});\n\nasync function run() {\n const result = await arena.metadata.getProtectedResource({\n xFapiInteractionId: \"1152537a-7f40-4405-860e-0fbdc75837b3\",\n });\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\n## Error Handling\n\n[`ArenaError`](./src/models/errors/arena-error.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 { Arena } from \"@authlete/arena\";\nimport * as errors from \"@authlete/arena/models/errors\";\n\nconst arena = new Arena({\n serverURL: \"https://api.example.com\",\n});\n\nasync function run() {\n try {\n const result = await arena.metadata.getOpenApiDocument({\n xFapiInteractionId: \"1152537a-7f40-4405-860e-0fbdc75837b3\",\n });\n\n console.log(result);\n } catch (error) {\n // The base class for HTTP error responses\n if (error instanceof errors.ArenaError) {\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.GetOpenapiBadRequestError) {\n console.log(error.data$.result); // operations.GetOpenapiResult\n }\n }\n }\n}\n\nrun();\n\n```\n\n### Error Classes\n**Primary error:**\n* [`ArenaError`](./src/models/errors/arena-error.ts): The base class for HTTP error responses.\n\nLess common errors (38)
\n\n
\n\n**Network errors:**\n* [`ConnectionError`](./src/models/errors/http-client-errors.ts): HTTP client was unable to make a request to a server.\n* [`RequestTimeoutError`](./src/models/errors/http-client-errors.ts): HTTP request timed out due to an AbortSignal signal.\n* [`RequestAbortedError`](./src/models/errors/http-client-errors.ts): HTTP request was aborted by the client.\n* [`InvalidRequestError`](./src/models/errors/http-client-errors.ts): Any input used to create a request is invalid.\n* [`UnexpectedClientError`](./src/models/errors/http-client-errors.ts): Unrecognised or unexpected error.\n\n\n**Inherit from [`ArenaError`](./src/models/errors/arena-error.ts)**:\n* [`GetOpenapiBadRequestError`](./src/models/errors/get-openapi-bad-request-error.ts): An error response indicating the value of the `format` request parameter is not supported. Status code `400`. Applicable to 1 of 35 methods.*\n* [`PatchSsfTransmitterTransmitterIdBadRequestError`](./src/models/errors/patch-ssf-transmitter-transmitter-id-bad-request-error.ts): The patch was rejected. Status code `400`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdStreamStreamIdVerifyBadRequestError`](./src/models/errors/post-ssf-transmitter-transmitter-id-stream-stream-id-verify-bad-request-error.ts): A verification event cannot be registered because the stream is disabled. Status code `400`. Applicable to 1 of 35 methods.*\n* [`GetSsfTransmitterTransmitterIdNotFoundError`](./src/models/errors/get-ssf-transmitter-transmitter-id-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PutSsfTransmitterTransmitterIdNotFoundError`](./src/models/errors/put-ssf-transmitter-transmitter-id-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`DeleteSsfTransmitterTransmitterIdNotFoundError`](./src/models/errors/delete-ssf-transmitter-transmitter-id-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PatchSsfTransmitterTransmitterIdNotFoundError`](./src/models/errors/patch-ssf-transmitter-transmitter-id-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateJwksNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-jwks-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdEventRegisterNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-event-register-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`GetSsfTransmitterTransmitterIdStreamStreamIdEventListNotFoundError`](./src/models/errors/get-ssf-transmitter-transmitter-id-stream-stream-id-event-list-not-found-error.ts): There is no transmitter with the transmitter ID, or there is no stream with the stream ID that belongs to the transmitter. Status code `404`. Applicable to 1 of 35 methods.*\n* [`GetSsfTransmitterTransmitterIdStreamStreamIdEventEventJtiNotFoundError`](./src/models/errors/get-ssf-transmitter-transmitter-id-stream-stream-id-event-event-jti-not-found-error.ts): There is no transmitter with the transmitter ID, there is no stream with the stream ID that belongs to the transmitter, or there is no event with the JTI. Status code `404`. Applicable to 1 of 35 methods.*\n* [`DeleteSsfTransmitterTransmitterIdStreamStreamIdEventEventJtiNotFoundError`](./src/models/errors/delete-ssf-transmitter-transmitter-id-stream-stream-id-event-event-jti-not-found-error.ts): There is no transmitter with the transmitter ID, there is no stream with the stream ID that belongs to the transmitter, or there is no event with the JTI. Status code `404`. Applicable to 1 of 35 methods.*\n* [`GetSsfTransmitterTransmitterIdStreamListNotFoundError`](./src/models/errors/get-ssf-transmitter-transmitter-id-stream-list-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`GetSsfTransmitterTransmitterIdStreamStreamIdNotFoundError`](./src/models/errors/get-ssf-transmitter-transmitter-id-stream-stream-id-not-found-error.ts): There is no transmitter with the transmitter ID, or there is no stream with the stream ID that belongs to the transmitter. Status code `404`. Applicable to 1 of 35 methods.*\n* [`DeleteSsfTransmitterTransmitterIdStreamStreamIdNotFoundError`](./src/models/errors/delete-ssf-transmitter-transmitter-id-stream-stream-id-not-found-error.ts): There is no transmitter with the transmitter ID, or there is no stream with the stream ID that belong to the transmitter. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdStreamStreamIdVerifyNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-stream-stream-id-verify-not-found-error.ts): There is no transmitter with the transmitter ID, or there is no stream with the stream ID that belongs to the transmitter. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamCreateNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-create-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamReadNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-read-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamUpdateNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-update-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamReplaceNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-replace-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamDeleteNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-delete-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamVerifyNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-verify-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamPollStreamIdNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-poll-stream-id-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamStatusReadNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-status-read-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamStatusUpdateNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-status-update-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamSubjectAddNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-subject-add-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamSubjectRemoveNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-subject-remove-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateStreamSubjectListNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-stream-subject-list-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateWellKnownOauthProtectedResourceNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-well-known-oauth-protected-resource-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`PostSsfTransmitterTransmitterIdDelegateWellKnownSsfConfigurationNotFoundError`](./src/models/errors/post-ssf-transmitter-transmitter-id-delegate-well-known-ssf-configuration-not-found-error.ts): There is no transmitter with the transmitter ID. Status code `404`. Applicable to 1 of 35 methods.*\n* [`GetProbeDatabaseServiceUnavailableError`](./src/models/errors/get-probe-database-service-unavailable-error.ts): An error response indicating that the database connection is down. Status code `503`. Applicable to 1 of 35 methods.*\n* [`GetProbeStartupServiceUnavailableError`](./src/models/errors/get-probe-startup-service-unavailable-error.ts): An error response indicating that this web application failed to start up. Status code `503`. Applicable to 1 of 35 methods.*\n* [`ResponseValidationError`](./src/models/errors/response-validation-error.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