Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/speakeasy-sdks/testcompany-sample-sdk-45

A typescript SDK for accessing the The-Speakeasy-Bar API.
https://github.com/speakeasy-sdks/testcompany-sample-sdk-45
Last synced: 2 days ago
JSON representation
A typescript SDK for accessing the The-Speakeasy-Bar API.
Host: GitHub
URL: https://github.com/speakeasy-sdks/testcompany-sample-sdk-45
Owner: speakeasy-sdks
License: mit
Created: 2023-11-07T23:27:44.000Z (almost 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:51:51.000Z (7 months ago)
Last Synced: 2024-04-28T05:14:54.084Z (6 months ago)
Language: TypeScript
Size: 320 KB
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # Speakeasy Bar Starter SDK



    

    






This is a sample SDK generated for the Speakeasy Bar API. Have a look around and familiarize yourself with the Speakeasy Product!

When you're ready you can use this modify this repo to reference your own OpenAPI spec or go back to the Speakeasy app to complete onboarding and generate your first SDK!

## 🏗 **Welcome to your new SDK!** 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)

- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)

- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)

- [ ] ✨ When ready to productionize, delete this section from the README

### Local development

Once you have the SDK setup you may want to iterate on the SDK. Speakeasy supports OpenAPI vendor extensions that can be added to your spec to customize the SDK ergonomics (method names, namespacing resources etc.) and functionality (adding retries, pagination, multiple server support etc)

To get started install the Speakeasy CLI.

In your terminal, run:

```bash

brew install speakeasy-api/homebrew-tap/speakeasy

```

Once you annonate your spec with an extension you will want to run `speakeasy validate` to check the spec for correctness and `speakeasy generate` to recreate the SDK locally. More documentation on OpenAPI extensions [here](https://speakeasyapi.dev/docs/customize-sdks/namespaces/). Here's an example of adding a multiple server support to the spec so that your SDK supports production and sandbox versions of your API. The attached Makefile also attaches some helper commands.

```yaml

info:

  title: Example

  version: 0.0.1

servers:

  - url: https://prod.example.com # Used as the default URL by the SDK

    description: Our production environment

    x-speakeasy-server-id: prod

  - url: https://sandbox.example.com

    description: Our sandbox environment

    x-speakeasy-server-id: sandbox

```

Once you're finished iterating and happy with the output push only the latest version of spec into the repo and regenerate the SDK using step 6 above. 

## SDK Installation

### NPM

```bash

npm add The-Speakeasy-Bar

```

### Yarn

```bash

yarn add The-Speakeasy-Bar

```

## SDK Example Usage

### Example

```typescript

import { TheSpeakeasyBar } from "The-Speakeasy-Bar";

import { DrinkType } from "The-Speakeasy-Bar/dist/models/components";

import { ListDrinksRequest } from "The-Speakeasy-Bar/dist/models/operations";

async function run() {

    const sdk = new TheSpeakeasyBar();

    const drinkType: DrinkType = DrinkType.Spirit;

    const res = await sdk.drinks.listDrinks(drinkType);

    if (res.statusCode == 200) {

        // handle response

    }

}

run();

```

## Available Resources and Operations

### [authentication](docs/sdks/authentication/README.md)

* [authenticate](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.

### [drinks](docs/sdks/drinks/README.md)

* [getDrink](docs/sdks/drinks/README.md#getdrink) - Get a drink.

* [listDrinks](docs/sdks/drinks/README.md#listdrinks) - Get a list of drinks.

### [ingredients](docs/sdks/ingredients/README.md)

* [listIngredients](docs/sdks/ingredients/README.md#listingredients) - Get a list of ingredients.

### [orders](docs/sdks/orders/README.md)

* [createOrder](docs/sdks/orders/README.md#createorder) - Create an order.

### [config](docs/sdks/config/README.md)

* [subscribeToWebhooks](docs/sdks/config/README.md#subscribetowebhooks) - Subscribe to webhooks.

## Error Handling

Handling errors in this SDK should largely match your expectations.  All operations return a response object or throw an error.  If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object     | Status Code      | Content Type     |

| ---------------- | ---------------- | ---------------- |

| errors.APIError  | 5XX              | application/json |

| errors.SDKError  | 4xx-5xx          | */*              |

Example

```typescript

import { TheSpeakeasyBar } from "The-Speakeasy-Bar";

async function run() {

    const sdk = new TheSpeakeasyBar();

    let res;

    try {

        res = await sdk.authentication.authenticate({});

    } catch (err) {

        if (err instanceof errors.APIError) {

            console.error(err); // handle exception

            throw err;

        } else if (err instanceof errors.SDKError) {

            console.error(err); // handle exception

            throw err;

        }

    }

    if (res.statusCode == 200) {

        // handle response

    }

}

run();

```

## Server Selection

### Select Server by Name

You can override the default server globally by passing a server name to the `server: string` 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 |

| ----- | ------ | --------- |

| `prod` | `https://speakeasy.bar` | None |

| `staging` | `https://staging.speakeasy.bar` | None |

| `customer` | `https://{organization}.{environment}.speakeasy.bar` | `environment` (default is `prod`), `organization` (default is `api`) |

#### Example

```typescript

import { TheSpeakeasyBar } from "The-Speakeasy-Bar";

async function run() {

    const sdk = new TheSpeakeasyBar({

        server: "customer",

    });

    const res = await sdk.authentication.authenticate({});

    if (res.statusCode == 200) {

        // handle response

    }

}

run();

```

#### Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

 * `environment: models.ServerEnvironment`

 * `organization: string`

### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:

```typescript

import { TheSpeakeasyBar } from "The-Speakeasy-Bar";

async function run() {

    const sdk = new TheSpeakeasyBar({

        serverURL: "https://speakeasy.bar",

    });

    const res = await sdk.authentication.authenticate({});

    if (res.statusCode == 200) {

        // handle response

    }

}

run();

```

## Custom HTTP Client

The Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.

For example, you could specify a header for every request that your sdk makes as follows:

```typescript

import { The-Speakeasy-Bar } from "TheSpeakeasyBar";

import axios from "axios";

const httpClient = axios.create({

    headers: {'x-custom-header': 'someValue'}

})

const sdk = new TheSpeakeasyBar({defaultClient: httpClient});

```

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name     | Type     | Scheme   |

| -------- | -------- | -------- |

| `apiKey` | apiKey   | API key  |

To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:

```typescript

import { TheSpeakeasyBar } from "The-Speakeasy-Bar";

async function run() {

    const sdk = new TheSpeakeasyBar({

        apiKey: "",

    });

    const res = await sdk.authentication.authenticate({});

    if (res.statusCode == 200) {

        // handle response

    }

}

run();

```

# 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)