npm package: @naurt/api
Description: SDK for Naurt's API
Latest version: 0.1.2

# @naurt/api@0.1.2

A TypeScript SDK client for the api.naurt.net API.

## Usage

First, install the SDK from npm.

```bash
npm install @naurt/api --save
```

Next, try it out.


```ts
import {
  Configuration,
  FeedbackApi,
} from '@naurt/api';
import type { FeedbackOptionsRequest } from '@naurt/api';

async function example() {
  console.log("🚀 Testing @naurt/api SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: ApiKeyAuth
    apiKey: "YOUR API KEY",
  });
  const api = new FeedbackApi(config);

  try {
    const data = await api.feedbackOptions();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```


## Documentation

### API Endpoints

All URIs are relative to *https://api.naurt.net*

| Class | Method | HTTP request | Description
| ----- | ------ | ------------ | -------------
*FeedbackApi* | [**feedbackOptions**](docs/FeedbackApi.md#feedbackoptions) | **OPTIONS** /feedback/v2 | Options
*FeedbackApi* | [**feedbackPost**](docs/FeedbackApi.md#feedbackpost) | **POST** /feedback/v2 | Post
*FinalDestinationApi* | [**finaldestinationOptions**](docs/FinalDestinationApi.md#finaldestinationoptions) | **OPTIONS** /final-destination/v2 | Options
*FinalDestinationApi* | [**finaldestinationPost**](docs/FinalDestinationApi.md#finaldestinationpost) | **POST** /final-destination/v2 | Post
*RendezvousApi* | [**rendezvousOptions**](docs/RendezvousApi.md#rendezvousoptions) | **OPTIONS** /rendezvous/v1 | Options
*RendezvousApi* | [**rendezvousPost**](docs/RendezvousApi.md#rendezvouspost) | **POST** /rendezvous/v1 | Post


### Models

- [Accuracy](docs/Accuracy.md)
- [Country](docs/Country.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [Feature](docs/Feature.md)
- [FeatureCollection](docs/FeatureCollection.md)
- [FeatureGeometry](docs/FeatureGeometry.md)
- [FeatureProperties](docs/FeatureProperties.md)
- [FeedbackLocation](docs/FeedbackLocation.md)
- [FeedbackQuery](docs/FeedbackQuery.md)
- [FeedbackRequest](docs/FeedbackRequest.md)
- [FeedbackResponse](docs/FeedbackResponse.md)
- [FinalDestinationHit](docs/FinalDestinationHit.md)
- [FinalDestinationHitGeojson](docs/FinalDestinationHitGeojson.md)
- [FinalDestinationHits](docs/FinalDestinationHits.md)
- [FinalDestinationLocation](docs/FinalDestinationLocation.md)
- [FinalDestinationLogging](docs/FinalDestinationLogging.md)
- [FinalDestinationOptions](docs/FinalDestinationOptions.md)
- [FinalDestinationQuery](docs/FinalDestinationQuery.md)
- [FinalDestinationRequest](docs/FinalDestinationRequest.md)
- [FinalDestinationResponse](docs/FinalDestinationResponse.md)
- [FinalDestinationSourceIdRequest](docs/FinalDestinationSourceIdRequest.md)
- [FinalDestinationSourceIdResponse](docs/FinalDestinationSourceIdResponse.md)
- [FinalDestinationStatus](docs/FinalDestinationStatus.md)
- [GeojsonType](docs/GeojsonType.md)
- [InputFilter](docs/InputFilter.md)
- [KeyValue](docs/KeyValue.md)
- [Language](docs/Language.md)
- [Multipoint](docs/Multipoint.md)
- [OptionsResponse](docs/OptionsResponse.md)
- [Point](docs/Point.md)
- [Polygon](docs/Polygon.md)
- [RendezvousHit](docs/RendezvousHit.md)
- [RendezvousHitData](docs/RendezvousHitData.md)
- [RendezvousQuery](docs/RendezvousQuery.md)
- [RendezvousRequest](docs/RendezvousRequest.md)
- [RendezvousResponse](docs/RendezvousResponse.md)
- [StructuredAddress](docs/StructuredAddress.md)

### Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
#### ApiKeyAuth


- **Type**: API key
- **API key parameter name**: `Authorization`
- **Location**: HTTP header

## About

This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
and is automatically generated by the
[OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `0.1.2`
- Package version: `0.1.2`
- Generator version: `7.20.0`
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`

The generated npm module supports the following:

- Environments
  * Node.js
  * Webpack
  * Browserify
- Language levels
  * ES5 - you must have a Promises/A+ library installed
  * ES6
- Module systems
  * CommonJS
  * ES6 module system


## Development

### Building

To build the TypeScript source code, you need to have Node.js and npm installed.
After cloning the repository, navigate to the project directory and run:

```bash
npm install
npm run build
```

### Publishing

Once you've built the package, you can publish it to npm:

```bash
npm publish
```

## License

[MIT](https://opensource.org/licenses/MIT)