Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/test-bar-ts
A typescript SDK for accessing the another-test-bar API.
https://github.com/speakeasy-sdks/test-bar-ts
Last synced: 1 day ago
JSON representation
A typescript SDK for accessing the another-test-bar API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/test-bar-ts
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-09-27T08:09:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:46:05.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:53.296Z (6 months ago)
- Language: TypeScript
- Size: 273 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# test-bar-ts
## 🏗 **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
## SDK Installation
### NPM
```bash
npm add https://github.com/speakeasy-sdks/test-bar-ts
```
### Yarn
```bash
yarn add https://github.com/speakeasy-sdks/test-bar-ts
```
## SDK Example Usage
### Example
```typescript
import { AnotherTestBar } from "test-bar-ts";
async function run() {
const sdk = new AnotherTestBar({
apiKey: "",
});
const res = await sdk.drinks.getDrink({
name: "",
});
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 { AnotherTestBar } from "test-bar-ts";
async function run() {
const sdk = new AnotherTestBar();
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 { AnotherTestBar } from "test-bar-ts";
async function run() {
const sdk = new AnotherTestBar({
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 { AnotherTestBar } from "test-bar-ts";
async function run() {
const sdk = new AnotherTestBar({
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 { test-bar-ts } from "AnotherTestBar";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new AnotherTestBar({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 { AnotherTestBar } from "test-bar-ts";
async function run() {
const sdk = new AnotherTestBar({
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)