# @haven1/sdk-api-client

### Key Features

* **OpenAPI Specification Compliance**: Built on OpenAPI standards for robust and scalable API interactions.
* **Type-Safe Integration**: Includes TypeScript support with fully typed responses and requests for improved development confidence.
* **Simplified API Calls**: Ready-to-use methods for common operations, reducing boilerplate code.
* **Flexible Configuration**: Easily customize base URLs, API keys, and other settings.

### Installation

Install the package using your preferred package manager:

{% tabs %}
{% tab title="npm" %}

```sh
npm install @haven1/sdk-api-client
```

{% endtab %}

{% tab title="yarn" %}

```sh
yarn add @haven1/sdk-api-client
```

{% endtab %}

{% tab title="pnpm" %}

```sh
pnpm add @haven1/sdk-api-client
```

{% endtab %}
{% endtabs %}

### Classes

* AuthModule
* Haven1SDK
* SdkModule

### Type Aliases

* Config
* GuardianTransactionResponse
* IdentityDetailResponse
* IdentityReferralResponse
* NotificationsErrorResponse
* NotificationsItem
* NotificationsParameters
* NotificationsSuccessResponse


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.haven1.org/build/developer-tools/haven1-sdk/haven1-sdk-api-client.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
