\n\n## SDK Installation\n\n### NPM\n\n```bash\nnpm add https://github.com/speakeasy-sdks/bar-typescript\n```\n\n### Yarn\n\n```bash\nyarn add https://github.com/speakeasy-sdks/bar-typescript\n```\n\n\n\n## SDK Example Usage\n\n### Example 1\n\n```typescript\nimport { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\n security: {\n apiKey: \"\",\n },\n});\n\nasync function run() {\n const result = await barSDK.drinks.listDrinks();\n\n console.log(result);\n}\n\nrun();\n\n```\n\n### Example 2\n\n```typescript\nimport { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\n security: {\n apiKey: \"\",\n },\n});\n\nasync function run() {\n const result = await barSDK.orders.createOrder([]);\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\n## Available Resources and Operations\n\n\nAvailable methods\n\n### [authentication](docs/sdks/authentication/README.md)\n\n* [authenticate](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.\n\n### [config](docs/sdks/config/README.md)\n\n* [subscribeToWebhooks](docs/sdks/config/README.md#subscribetowebhooks) - Subscribe to webhooks.\n\n### [drinks](docs/sdks/drinks/README.md)\n\n* [getDrink](docs/sdks/drinks/README.md#getdrink) - Get a drink.\n* [listDrinks](docs/sdks/drinks/README.md#listdrinks) - Get a list of drinks.\n\n### [food](docs/sdks/food/README.md)\n\n* [getFood](docs/sdks/food/README.md#getfood) - Get a food item.\n* [listFoods](docs/sdks/food/README.md#listfoods) - Get a list of food items.\n\n### [ingredients](docs/sdks/ingredients/README.md)\n\n* [listIngredients](docs/sdks/ingredients/README.md#listingredients) - Get a list of ingredients.\n\n### [orders](docs/sdks/orders/README.md)\n\n* [createOrder](docs/sdks/orders/README.md#createorder) - Create an order.\n\n\n\n\n\n## Error Handling\n\n[`BarSDKError`](./src/sdk/models/errors/barsdkerror.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 { BarSDK } from \"@2ynn/speakeasy-bar\";\nimport * as errors from \"@2ynn/speakeasy-bar/sdk/models/errors\";\n\nconst barSDK = new BarSDK();\n\nasync function run() {\n try {\n const result = await barSDK.authentication.authenticate({});\n\n console.log(result);\n } catch (error) {\n // The base class for HTTP error responses\n if (error instanceof errors.BarSDKError) {\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.APIError) {\n console.log(error.data$.code); // string\n console.log(error.data$.details); // { [k: string]: any }\n console.log(error.data$.message); // string\n }\n }\n }\n}\n\nrun();\n\n```\n\n### Error Classes\n**Primary errors:**\n* [`BarSDKError`](./src/sdk/models/errors/barsdkerror.ts): The base class for HTTP error responses.\n * [`APIError`](./src/sdk/models/errors/apierror.ts): An error occurred interacting with the API. Status code `5XX`.\n\nLess common errors (6)\n\n \n\n**Network errors:**\n* [`ConnectionError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.\n* [`RequestTimeoutError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.\n* [`RequestAbortedError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.\n* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.\n* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.\n\n\n**Inherit from [`BarSDKError`](./src/sdk/models/errors/barsdkerror.ts)**:\n* [`ResponseValidationError`](./src/sdk/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\n\n\n\n## Server Selection\n\n### Select Server by Name\n\nYou can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:\n\n| Name | Server | Variables | Description |\n| ---------- | ---------------------------------------------------- | -------------------------------- | ------------------------------------------- |\n| `prod` | `https://speakeasy.bar` | | The production server. |\n| `staging` | `https://staging.speakeasy.bar` | | The staging server. |\n| `customer` | `https://{organization}.{environment}.speakeasy.bar` | `environment` `organization` | A per-organization and per-environment API. |\n\nIf the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:\n\n| Variable | Parameter | Supported Values | Default | Description |\n| -------------- | --------------------------------------- | ------------------------------------------ | -------- | ------------------------------------------------------------- |\n| `environment` | `environment: models.ServerEnvironment` | - `\"prod\"` - `\"staging\"` - `\"dev\"` | `\"prod\"` | The environment name. Defaults to the production environment. |\n| `organization` | `organization: string` | string | `\"api\"` | The organization name. Defaults to a generic organization. |\n\n#### Example\n\n```typescript\nimport { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\n server: \"customer\",\n environment: \"dev\",\n organization: \"api\",\n});\n\nasync function run() {\n const result = await barSDK.authentication.authenticate({});\n\n console.log(result);\n}\n\nrun();\n\n```\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:\n```typescript\nimport { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\n serverURL: \"https://speakeasy.bar\",\n});\n\nasync function run() {\n const result = await barSDK.authentication.authenticate({});\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\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 { BarSDK } from \"@2ynn/speakeasy-bar\";\nimport { HTTPClient } from \"@2ynn/speakeasy-bar/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 BarSDK({ httpClient: httpClient });\n```\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 |\n| ------------------- | ------ | ------------ |\n| `apiKey` | apiKey | API key |\n| `clientCredentials` | oauth2 | OAuth2 token |\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 { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\n security: {\n apiKey: \"\",\n },\n});\n\nasync function run() {\n const result = await barSDK.authentication.authenticate({});\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\n## Summary\n\nThe Speakeasy Bar: A bar that serves drinks.\n\nA secret underground bar that serves drinks to those in the know.\n\nFor more information about the API: [The Speakeasy Bar Documentation.](https://docs.speakeasy.bar)\n\n\n\n## Table of Contents\n\n * [SDK Installation](#sdk-installation)\n * [SDK Example Usage](#sdk-example-usage)\n * [Available Resources and Operations](#available-resources-and-operations)\n * [Error Handling](#error-handling)\n * [Server Selection](#server-selection)\n * [Custom HTTP Client](#custom-http-client)\n * [Authentication](#authentication)\n * [SDK Installation](#sdk-installation-1)\n * [Requirements](#requirements)\n * [Standalone functions](#standalone-functions)\n * [Retries](#retries)\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 @2ynn/speakeasy-bar\n```\n\n### PNPM\n\n```bash\npnpm add @2ynn/speakeasy-bar\n```\n\n### Bun\n\n```bash\nbun add @2ynn/speakeasy-bar\n```\n\n### Yarn\n\n```bash\nyarn add @2ynn/speakeasy-bar\n```\n\n\n\n## Requirements\n\nFor supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).\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- [`authenticationAuthenticate`](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.\n- [`configSubscribeToWebhooks`](docs/sdks/config/README.md#subscribetowebhooks) - Subscribe to webhooks.\n- [`drinksGetDrink`](docs/sdks/drinks/README.md#getdrink) - Get a drink.\n- [`drinksListDrinks`](docs/sdks/drinks/README.md#listdrinks) - Get a list of drinks.\n- [`foodGetFood`](docs/sdks/food/README.md#getfood) - Get a food item.\n- [`foodListFoods`](docs/sdks/food/README.md#listfoods) - Get a list of food items.\n- [`ingredientsListIngredients`](docs/sdks/ingredients/README.md#listingredients) - Get a list of ingredients.\n- [`ordersCreateOrder`](docs/sdks/orders/README.md#createorder) - Create an order.\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 { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK();\n\nasync function run() {\n const result = await barSDK.authentication.authenticate({}, {\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 { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst barSDK = new BarSDK({\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 barSDK.authentication.authenticate({});\n\n console.log(result);\n}\n\nrun();\n\n```\n\n\n\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 { BarSDK } from \"@2ynn/speakeasy-bar\";\n\nconst sdk = new BarSDK({ debugLogger: console });\n```\n\n\n\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, this library is generated programmatically.\nFeel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\"){kind=icon}
\n