SDK Installation

NPM

npm add https://github.com/speakeasy-sdks/bar-typescript

Yarn

yarn add https://github.com/speakeasy-sdks/bar-typescript

SDK Example Usage

Example 1

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await barSDK.drinks.listDrinks();

  // Handle the result
  console.log(result);
}

run();

Example 2

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";
import { OrderType } from "@speakeasy-sdks/speakeasy-bar/sdk/models/shared";

const barSDK = new BarSDK({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await barSDK.orders.createOrder([
    {
      productCode: "APM-1F2D3",
      quantity: 567805,
      type: OrderType.Ingredient,
    },
    {
      productCode: "AC-A2DF3",
      quantity: 618237,
      type: OrderType.Ingredient,
    },
  ]);

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

authentication

• authenticate - Authenticate with the API by providing a username and password.

config

• subscribeToWebhooks - Subscribe to webhooks.

drinks

• getDrink - Get a drink.
• listDrinks - Get a list of drinks.

ingredients

• listIngredients - Get a list of ingredients.

orders

• createOrder - Create an order.

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the sdk/models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the authenticate method may throw the following errors:

| Error Type | Status Code | Content Type | | --------------- | ----------- | ---------------- | | errors.APIError | 5XX | application/json | | errors.SDKError | 4XX | */* |

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";
import {
  APIError,
  SDKValidationError,
} from "@speakeasy-sdks/speakeasy-bar/sdk/models/errors";

const barSDK = new BarSDK();

async function run() {
  let result;
  try {
    result = await barSDK.authentication.authenticate({});

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof APIError): {
        // Handle err.data$: APIErrorData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Validation 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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

Server Selection

Select Server by Name

You 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:

| Name | Server | Variables | Default values | | ---------- | ---------------------------------------------------- | ------------------------------------------------------------------ | -------------------- | | prod | https://speakeasy.bar | | | | staging | https://staging.speakeasy.bar | | | | customer | https://{organization}.{environment}.speakeasy.bar | environment: models.ServerEnvironmentorganization: string | "prod""api" |

If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.

Example

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK({
  server: "customer",
});

async function run() {
  const result = await barSDK.authentication.authenticate({});

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The 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:

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK({
  serverURL: "https://speakeasy.bar",
});

async function run() {
  const result = await barSDK.authentication.authenticate({});

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";
import { HTTPClient } from "@speakeasy-sdks/speakeasy-bar/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new BarSDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | ------------------- | ------ | ------------ | | apiKey | apiKey | API key | | clientCredentials | oauth2 | OAuth2 token |

You 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:

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await barSDK.authentication.authenticate({});

  // Handle the result
  console.log(result);
}

run();

Summary

The Speakeasy Bar: A bar that serves drinks.

A secret underground bar that serves drinks to those in the know.

For more information about the API: The Speakeasy Bar Documentation.

Table of Contents

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• SDK Installation
• Requirements
• Standalone functions
• Retries
• Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @speakeasy-sdks/speakeasy-bar

PNPM

pnpm add @speakeasy-sdks/speakeasy-bar

Bun

bun add @speakeasy-sdks/speakeasy-bar

Yarn

yarn add @speakeasy-sdks/speakeasy-bar zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• authenticationAuthenticate - Authenticate with the API by providing a username and password.
• configSubscribeToWebhooks - Subscribe to webhooks.
• drinksGetDrink - Get a drink.
• drinksListDrinks - Get a list of drinks.
• ingredientsListIngredients - Get a list of ingredients.
• ordersCreateOrder - Create an order.

Retries

Some 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.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK();

async function run() {
  const result = await barSDK.authentication.authenticate({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const barSDK = new BarSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await barSDK.authentication.authenticate({});

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] 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.

import { BarSDK } from "@speakeasy-sdks/speakeasy-bar";

const sdk = new BarSDK({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel 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!

SDK Created by Speakeasy