# hetzner-sdk-ts

> Generated TypeScript SDK for Hetzner Cloud API

Latest version **1.0.1** (published 2023-12-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install hetzner-sdk-ts
pnpm add hetzner-sdk-ts
yarn add hetzner-sdk-ts
bun add hetzner-sdk-ts
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-12-18 |
| First published | 2023-12-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | thedjpetersen |

## Links

- npm: https://www.npmjs.com/package/hetzner-sdk-ts
- npm.io page: https://npm.io/package/hetzner-sdk-ts

## Recent versions

- 1.0.1 (latest) — 2023-12-18
- 1.0.0 — 2023-12-18

## README

<a name="readme-top"></a>

<!-- PROJECT SHIELDS -->

<!-- BADGES_START -->

<!-- BADGES_END -->

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/thedjpetersen/hetzner-sdk-ts">
    <img src="images/hetzner-sdk.png" alt="Logo" width="250" height="250">
  </a>

# Hetzner Typescript SDK

<h3 align="center">Javascript client for interacting with the Hetzner API</h3>

  <p align="center">
    Leveraging the OpenAPI definitions to gracefully generate a client on a regular cadence - also generates typescript types for the API
    <br />
    <a href="https://github.com/thedjpetersen/hetzner-sdk-ts"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/thedjpetersen/hetzner-sdk-ts/issues">Report Bug</a>
    ·
    <a href="https://github.com/thedjpetersen/hetzner-sdk-ts/issues">Request Feature</a>
  </p>
</div>

<details>
    <summary>Table of Contents</summary>
    <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#api">API</a></li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

There are currently a few different SDKs for interacting with the Hetzner API, but none of them were staying up to date using the current OpenAPI definition published on the Hetzner website. This project aims to solve that by using the OpenAPI definition to generate a client on a regular cadence.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## Getting Started

To get setup we just need to install the library locally and then we can start defining
our states and transitions.

### Installation

```sh
npm install hetzner-sdk-ts
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## API

## Usage

```typescript
import { OpenAPI, ServersService } from "hetzner-sdk-ts";

// Set the API key - this will apply globally to all requests
OpenAPI.TOKEN = apiKey;

// Get a list of all servers
const { servers } = await ServersService.listServers();
```

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTACT -->

## Contact

DJ Petersen - [@thedjpetersen](https://twitter.com/thedjpetersen)

Project Link: [https://github.com/thedjpetersen/hetzner-sdk-ts](https://github.com/thedjpetersen/hetzner-sdk-ts)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS -->

## Acknowledgments

- [ChatGPT](https://chat.openai.com/)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

---
_Source: https://npm.io/package/hetzner-sdk-ts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._