# ntlango-api-client

> Ntlango API typescript client

Latest version **1.0.3** (published 2023-10-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install ntlango-api-client
pnpm add ntlango-api-client
yarn add ntlango-api-client
bun add ntlango-api-client
```

## 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.3 |
| Published | 2023-10-23 |
| First published | 2023-10-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 337.5 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | mapapa.solutions.inc |

## Links

- npm: https://www.npmjs.com/package/ntlango-api-client
- npm.io page: https://npm.io/package/ntlango-api-client

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [axios-retry](https://npm.io/package/axios-retry.md) ^3.3.1
- [ntlango-api-model](https://npm.io/package/ntlango-api-model.md) ^1.0.3
- [@openapitools/openapi-generator-cli](https://npm.io/package/@openapitools/openapi-generator-cli.md) ^2.7.0

## Recent versions

- 1.0.3 (latest) — 2023-10-23
- 1.0.2 — 2023-10-23
- 1.0.1 — 2023-10-15
- 1.0.0 — 2023-10-15

## README

# Ntlango API Client

The Ntlango API Client is a TypeScript client for the Ntlango API, generated from the OpenAPI specification located in the `ntlango-api-model` npm.

## Table of Contents

- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
  - [Initializing the Client](#initializing-the-client)
  - [Making API Requests](#making-api-requests)
- [Contributing](#contributing)
- [License](#license)

## Getting Started

### Prerequisites

Before using the Ntlango API Client, make sure you have the following prerequisites installed:

- Node.js
- npm (Node Package Manager)

### Installation

To install the Ntlango API Client, follow these steps:

1. Install the `ntlango-api-client` npm package.

```markdown
npm install ntlango-api-client
```

## Usage
### Initializing the Client

You need to initialize the Ntlango API Client before making API requests. To do so, you can create an instance of the NtlangoClient class.

```
import { NtlangoClient } from 'ntlango-api-client';

const ntlangoInitializationProps = {
  baseUrl: 'https://api.beta.ntlango.com/api/v1',
};

const client = new NtlangoClient(ntlangoInitializationProps);
```

### Making API Requests

With the client initialized, you can make API requests using the ntlangoClient instance.

```
const response = await client.ntlangoClient.someApiEndpoint(parameters);
console.log(response.data); // Process the API response
```

## Contributing

We welcome contributions to the Ntlango API Client. If you find a bug or have an improvement in mind, please open an issue or submit a pull request in the ntlango-api-client repository.

## License

This project is licensed under the MIT License.

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