npm package: @oktus/sdk
Description: Official Oktus API SDK generated from OpenAPI schemas
Author: Oktus GmbH
Latest version: 0.0.5

<h1 align="center" style="border-bottom: none">
<br>
<a href="https://oktus.io" rel="noopener noreferrer" target="_blank">
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://app.oktus.io/logos/oktus_white.svg">
  <img height="75" alt="Oktus Logo" src="https://app.oktus.io/logos/oktus.svg">
</picture>
</a>
<br>
<br>
<a href="https://oktus.io"><img src="https://img.shields.io/static/v1?label=Oktus&message=Website&color=309ED6&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNTI5cHgiIGhlaWdodD0iNTI5cHgiIHZpZXdCb3g9IjAgMCA1MjkgNTI5IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPgogICAgPHRpdGxlPm9rdHVzPC90aXRsZT4KICAgIDxnIGlkPSJQYWdlLTEiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxnIGlkPSJBcnRib2FyZCIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTIzNi4wMDAwMDAsIC0yMzUuMDAwMDAwKSIgZmlsbD0iI0ZGRkZGRiIgZmlsbC1ydWxlPSJub256ZXJvIj4KICAgICAgICAgICAgPGcgaWQ9Im9rdHVzIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgyMzYuMDAwMDAwLCAyMzUuMDAwMDAwKSI+CiAgICAgICAgICAgICAgICA8cGF0aCBkPSJNNDg0LjYxMjc3OCwxMzMuMDk5MDU4IEwyNjUuOTg1MTQ5LDEzMy4wOTkwNTggQzE5My44NTMxMjMsMTMzLjA5OTA1OCAxMzQuMDUzOTM5LDE5MC42MTI0NDYgMTMzLjExNjAzOSwyNjIuNzQ0MDQ1IEMxMzIuNzk2MjI0LDI4My44MTc0ODQgMTM3LjU3ODU4NiwzMDQuNjU1NTg1IDE0Ny4wNTUxNjgsMzIzLjQ4MDc2OSBDMTQ3Ljg3Mzc1MSwzMjUuMTUxNDEgMTQ3Ljc3Mjk1NCwzMjcuMTI2MDc4IDE0Ni43ODg1MTIsMzI4LjcwNDY4NCBDMTQ1LjgwNDA3LDMzMC4yODMyOSAxNDQuMDc1MTYsMzMxLjI0MjY1MSAxNDIuMjE0NzQzLDMzMS4yNDI2NTEgTDEyLjY5ODM1NTYsMzMxLjI0MjY1MSBDMTAuMjI3NTM2NSwzMzEuMjQyNjUxIDguMDcyNzE0NjYsMzI5LjU2Mzc4OCA3LjQ2OTgzNDg1LDMyNy4xNjc2NjMgQzMuMjg4NDIzMDEsMzA5LjkxOTUyNSAwLjg1MDU3NzM3OSwyOTIuMjk0OTA4IDAuMTkzMDI3NjQ3LDI3NC41NTkzNTMgQy01LjU1Mjk1NDkzLDEyMC45MTcyMTYgMTE3LjcyMTU0OSwtMy44NDQyNTMyNCAyNzEuNDE4NDk4LDAuMDkwNTg5NjA4MSBDMzYwLjM3MDY5LDIuMzc1MTM4MjUgNDQyLjIwODAyNCw0OS4yNDkwMTcxIDQ4OS4xODM2OTEsMTI0LjgxOTcxOCBDNDkwLjIzOTYyMywxMjYuNDgyODA1IDQ5MC4zMDQxNywxMjguNTg5NDcgNDg5LjM1MjAzNSwxMzAuMzE0MDgyIEM0ODguMzk5ODk5LDEzMi4wMzg2OTQgNDg2LjU4Mjc2LDEzMy4xMDY1MTggNDg0LjYxMjc3OCwxMzMuMDk5MDU4IFogTTUxNi4zMDczMTYsMTk3Ljc4MTQwNiBMMzg2Ljc5MDkyOSwxOTcuNzgxNDA2IEMzODQuOTMwNTEyLDE5Ny43ODE0MDIgMzgzLjIwMTYwMiwxOTguNzQwNzY4IDM4Mi4yMTcxNiwyMDAuMzE5MzczIEMzODEuMjMyNzE4LDIwMS44OTc5NzkgMzgxLjEzMTkyMSwyMDMuODcyNjQ4IDM4MS45NTA1MDQsMjA1LjU0MzI4OCBDMzkxLjQyNTQ2OSwyMjQuMzY5MDU2IDM5Ni4yMDc3MzgsMjQ1LjIwNjc1NCAzOTUuODg5NjMzLDI2Ni4yODAwMTMgQzM5NC45NTE3MzMsMzM4LjQwMDgzMSAzMzUuMTUyNTQ5LDM5NS45MTQyMTkgMjYzLjAyMDUyMywzOTUuOTE0MjE5IEw0NC4zOTI4OTM2LDM5NS45MTQyMTkgQzQyLjQzODAxMTksMzk1LjkzMjcwNSA0MC42NDYzNzg4LDM5Ny4wMDgyMDYgMzkuNzEwODY1LDM5OC43MjQ3OTYgQzM4Ljc3NTM1MTIsNDAwLjQ0MTM4NyAzOC44NDI2MjI1LDQwMi41Mjk5NDggMzkuODg2NjYzNCw0MDQuMTgyNzc5IEM4Ni44NTk1Mjk0LDQ3OS43NTYzODQgMTY4LjY5ODU3Nyw1MjYuNjMxMjQ0IDI1Ny42NTE4NTcsNTI4LjkxMTkwNyBDNDA5Ljc0MjUxNyw1MzIuODE0NDA5IDUzNC41MDQ3MjUsNDA2LjUzMjkwNCA1MjguODEyNjQ0LDI1NC40MjE1ODIgQzUyOC4xNTUwOTQsMjM2LjY4NjAyOCA1MjUuNzE3MjQ5LDIxOS4wNjE0MTEgNTIxLjUzNTgzNywyMDEuODEzMjczIEM1MjAuOTI0NjI1LDE5OS40MjU3MDkgNTE4Ljc3MTg4NSwxOTcuNzU5ODQxIDUxNi4zMDczMTYsMTk3Ljc1OTg0MSBMNTE2LjMwNzMxNiwxOTcuNzgxNDA2IFogTTI2NC40OTc0NDYsMjE2LjI2OTc3NiBDMjQ0Ljk4NDE4LDIxNi4yNjk3NzYgMjI3LjM5MjUxOSwyMjguMDI0NzkyIDIxOS45MjYxMjMsMjQ2LjA1MzAwOSBDMjEyLjQ1OTcyNywyNjQuMDgxMjI3IDIxNi41ODkxMywyODQuODMxOTI0IDIzMC4zODg2MzQsMjk4LjYyODI2MyBDMjQ0LjE4ODEzOCwzMTIuNDI0NjAyIDI2NC45Mzk4ODEsMzE2LjU0OTM0MyAyODIuOTY2NTM2LDMwOS4wNzg5NjIgQzMwMC45OTMxOTEsMzAxLjYwODU4MiAzMTIuNzQ0MzQzLDI4NC4wMTQzOTggMzEyLjczOTk4NCwyNjQuNTAxMjQ4IEMzMTIuNzM5OTg0LDI1MS43MDc1OTkgMzA3LjY1Njk1NywyMzkuNDM4MTAxIDI5OC42MDk0MTcsMjMwLjM5MjYzNiBDMjg5LjU2MTg3NiwyMjEuMzQ3MTcxIDI3Ny4yOTExNzEsMjE2LjI2NjkxOCAyNjQuNDk3NDQ2LDIxNi4yNjk3NzYgTDI2NC40OTc0NDYsMjE2LjI2OTc3NiBaIiBpZD0iU2hhcGUiPjwvcGF0aD4KICAgICAgICAgICAgPC9nPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+&logoColor=%23fff"></a>
<a href="https://oktus.io/docs"><img src="https://img.shields.io/static/v1?label=Oktus&message=Documentation&color=309ED6&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iNTI5cHgiIGhlaWdodD0iNTI5cHgiIHZpZXdCb3g9IjAgMCA1MjkgNTI5IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPgogICAgPHRpdGxlPm9rdHVzPC90aXRsZT4KICAgIDxnIGlkPSJQYWdlLTEiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxnIGlkPSJBcnRib2FyZCIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTIzNi4wMDAwMDAsIC0yMzUuMDAwMDAwKSIgZmlsbD0iI0ZGRkZGRiIgZmlsbC1ydWxlPSJub256ZXJvIj4KICAgICAgICAgICAgPGcgaWQ9Im9rdHVzIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgyMzYuMDAwMDAwLCAyMzUuMDAwMDAwKSI+CiAgICAgICAgICAgICAgICA8cGF0aCBkPSJNNDg0LjYxMjc3OCwxMzMuMDk5MDU4IEwyNjUuOTg1MTQ5LDEzMy4wOTkwNTggQzE5My44NTMxMjMsMTMzLjA5OTA1OCAxMzQuMDUzOTM5LDE5MC42MTI0NDYgMTMzLjExNjAzOSwyNjIuNzQ0MDQ1IEMxMzIuNzk2MjI0LDI4My44MTc0ODQgMTM3LjU3ODU4NiwzMDQuNjU1NTg1IDE0Ny4wNTUxNjgsMzIzLjQ4MDc2OSBDMTQ3Ljg3Mzc1MSwzMjUuMTUxNDEgMTQ3Ljc3Mjk1NCwzMjcuMTI2MDc4IDE0Ni43ODg1MTIsMzI4LjcwNDY4NCBDMTQ1LjgwNDA3LDMzMC4yODMyOSAxNDQuMDc1MTYsMzMxLjI0MjY1MSAxNDIuMjE0NzQzLDMzMS4yNDI2NTEgTDEyLjY5ODM1NTYsMzMxLjI0MjY1MSBDMTAuMjI3NTM2NSwzMzEuMjQyNjUxIDguMDcyNzE0NjYsMzI5LjU2Mzc4OCA3LjQ2OTgzNDg1LDMyNy4xNjc2NjMgQzMuMjg4NDIzMDEsMzA5LjkxOTUyNSAwLjg1MDU3NzM3OSwyOTIuMjk0OTA4IDAuMTkzMDI3NjQ3LDI3NC41NTkzNTMgQy01LjU1Mjk1NDkzLDEyMC45MTcyMTYgMTE3LjcyMTU0OSwtMy44NDQyNTMyNCAyNzEuNDE4NDk4LDAuMDkwNTg5NjA4MSBDMzYwLjM3MDY5LDIuMzc1MTM4MjUgNDQyLjIwODAyNCw0OS4yNDkwMTcxIDQ4OS4xODM2OTEsMTI0LjgxOTcxOCBDNDkwLjIzOTYyMywxMjYuNDgyODA1IDQ5MC4zMDQxNywxMjguNTg5NDcgNDg5LjM1MjAzNSwxMzAuMzE0MDgyIEM0ODguMzk5ODk5LDEzMi4wMzg2OTQgNDg2LjU4Mjc2LDEzMy4xMDY1MTggNDg0LjYxMjc3OCwxMzMuMDk5MDU4IFogTTUxNi4zMDczMTYsMTk3Ljc4MTQwNiBMMzg2Ljc5MDkyOSwxOTcuNzgxNDA2IEMzODQuOTMwNTEyLDE5Ny43ODE0MDIgMzgzLjIwMTYwMiwxOTguNzQwNzY4IDM4Mi4yMTcxNiwyMDAuMzE5MzczIEMzODEuMjMyNzE4LDIwMS44OTc5NzkgMzgxLjEzMTkyMSwyMDMuODcyNjQ4IDM4MS45NTA1MDQsMjA1LjU0MzI4OCBDMzkxLjQyNTQ2OSwyMjQuMzY5MDU2IDM5Ni4yMDc3MzgsMjQ1LjIwNjc1NCAzOTUuODg5NjMzLDI2Ni4yODAwMTMgQzM5NC45NTE3MzMsMzM4LjQwMDgzMSAzMzUuMTUyNTQ5LDM5NS45MTQyMTkgMjYzLjAyMDUyMywzOTUuOTE0MjE5IEw0NC4zOTI4OTM2LDM5NS45MTQyMTkgQzQyLjQzODAxMTksMzk1LjkzMjcwNSA0MC42NDYzNzg4LDM5Ny4wMDgyMDYgMzkuNzEwODY1LDM5OC43MjQ3OTYgQzM4Ljc3NTM1MTIsNDAwLjQ0MTM4NyAzOC44NDI2MjI1LDQwMi41Mjk5NDggMzkuODg2NjYzNCw0MDQuMTgyNzc5IEM4Ni44NTk1Mjk0LDQ3OS43NTYzODQgMTY4LjY5ODU3Nyw1MjYuNjMxMjQ0IDI1Ny42NTE4NTcsNTI4LjkxMTkwNyBDNDA5Ljc0MjUxNyw1MzIuODE0NDA5IDUzNC41MDQ3MjUsNDA2LjUzMjkwNCA1MjguODEyNjQ0LDI1NC40MjE1ODIgQzUyOC4xNTUwOTQsMjM2LjY4NjAyOCA1MjUuNzE3MjQ5LDIxOS4wNjE0MTEgNTIxLjUzNTgzNywyMDEuODEzMjczIEM1MjAuOTI0NjI1LDE5OS40MjU3MDkgNTE4Ljc3MTg4NSwxOTcuNzU5ODQxIDUxNi4zMDczMTYsMTk3Ljc1OTg0MSBMNTE2LjMwNzMxNiwxOTcuNzgxNDA2IFogTTI2NC40OTc0NDYsMjE2LjI2OTc3NiBDMjQ0Ljk4NDE4LDIxNi4yNjk3NzYgMjI3LjM5MjUxOSwyMjguMDI0NzkyIDIxOS45MjYxMjMsMjQ2LjA1MzAwOSBDMjEyLjQ1OTcyNywyNjQuMDgxMjI3IDIxNi41ODkxMywyODQuODMxOTI0IDIzMC4zODg2MzQsMjk4LjYyODI2MyBDMjQ0LjE4ODEzOCwzMTIuNDI0NjAyIDI2NC45Mzk4ODEsMzE2LjU0OTM0MyAyODIuOTY2NTM2LDMwOS4wNzg5NjIgQzMwMC45OTMxOTEsMzAxLjYwODU4MiAzMTIuNzQ0MzQzLDI4NC4wMTQzOTggMzEyLjczOTk4NCwyNjQuNTAxMjQ4IEMzMTIuNzM5OTg0LDI1MS43MDc1OTkgMzA3LjY1Njk1NywyMzkuNDM4MTAxIDI5OC42MDk0MTcsMjMwLjM5MjYzNiBDMjg5LjU2MTg3NiwyMjEuMzQ3MTcxIDI3Ny4yOTExNzEsMjE2LjI2NjkxOCAyNjQuNDk3NDQ2LDIxNi4yNjk3NzYgTDI2NC40OTc0NDYsMjE2LjI2OTc3NiBaIiBpZD0iU2hhcGUiPjwvcGF0aD4KICAgICAgICAgICAgPC9nPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+&logoColor=%23fff"></a>
</h1>

<p align="center">
  Type-safe SDK for the Oktus API
</p>

<br>

<br>

## Install

```bash
# npm
$ npm i @oktus/sdk

# yarn
$ yarn add @oktus/sdk

# pnpm
$ pnpm add @oktus/sdk

# bun
$ bun add @oktus/sdk
```

## Usage

```ts
import { Oktus } from '@oktus/sdk'

const client = new Oktus({
  apiKey: 'YOUR_API_KEY'
})

const me = await client.getIdentityMe()
```

The package root exports the SDK client and core utility types.
If you need the full generated operation type aliases, import them from `@oktus/sdk/types`.

## Development

The SDK source is generated from OpenAPI schemas exported by `@oktus/api`.

```bash
pnpm --filter @oktus/sdk generate
```