An open API service indexing awesome lists of open source software.

https://github.com/leadpingai/leadping-typescript

Official TypeScript SDK for the Leadping API.
https://github.com/leadpingai/leadping-typescript

api-client javascript kiota leadping leadping-api nodejs npm openapi rest-api sdk typescript

Last synced: 3 days ago
JSON representation

Official TypeScript SDK for the Leadping API.

Awesome Lists containing this project

README

          

[![](https://img.shields.io/npm/v/@leadping/sdk.svg?style=for-the-badge)](https://www.npmjs.com/package/@leadping/sdk)
[![](https://img.shields.io/github/actions/workflow/status/leadpingai/leadping-typescript/publish.yml?style=for-the-badge)](https://github.com/leadpingai/leadping-typescript/actions/workflows/publish.yml)
[![](https://img.shields.io/npm/dt/@leadping/sdk.svg?style=for-the-badge)](https://www.npmjs.com/package/@leadping/sdk)
[![](https://img.shields.io/github/actions/workflow/status/leadpingai/leadping-typescript/codeql.yml?label=CodeQL&style=for-the-badge)](https://github.com/leadpingai/leadping-typescript/actions/workflows/codeql.yml)

# ![Leadping](https://leadping.ai/favicon.ico) Leadping TypeScript SDK

Type-safe TypeScript client for the Leadping API.

## Install

```bash
npm install @leadping/sdk
```

The generated client uses a Kiota request adapter. Install the default fetch adapter:

```bash
npm install @microsoft/kiota-http-fetchlibrary
```

GitHub Packages is also available:

```bash
npm config set @leadpingai:registry https://npm.pkg.github.com
npm install @leadpingai/sdk
```

## Use

```ts
import { createLeadpingOpenApiClient } from "@leadping/sdk";

const adapter = createLeadpingRequestAdapter();
const client = createLeadpingOpenApiClient(adapter);

const me = await client.users.me.get();
```

`createLeadpingRequestAdapter` is application code. Configure it to send one of:

- `Authorization: Bearer `
- `X-Leadping-Api-Key: `

The client defaults to `https://api.leadping.ai` when the adapter does not already have a base URL.

## Links

- [Documentation](https://leadping.ai/docs)
- [API reference](https://leadping.ai/docs/api-reference)
- [License](LICENSE)