# sip_loyalty_api_sdk

> SipScience's Loyalty API SDK for Typescript.

Latest version **1.1.0** (published 2022-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install sip_loyalty_api_sdk
pnpm add sip_loyalty_api_sdk
yarn add sip_loyalty_api_sdk
bun add sip_loyalty_api_sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2022-01-07 |
| First published | 2022-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Maintainers | sipscience |

## Links

- npm: https://www.npmjs.com/package/sip_loyalty_api_sdk
- npm.io page: https://npm.io/package/sip_loyalty_api_sdk

## Dependencies (2)

- [urlcat](https://npm.io/package/urlcat.md) ^2.0.4
- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.4

## Recent versions

- 1.1.0 (latest) — 2022-01-07

## README

# SIP Loyalty API SDK

SipScience's Loyalty API SDK for Typescript.

## Installation Instructions

Install the package via `npm`:

```
npm install sip_loyalty_api_sdk
```

or `yarn`:

```
yarn add sip_loyalty_api_sdk
```

## Usage Instructions

```js
import SIPLoyaltyAPI from 'sip_loyalty_api_sdk'

const api = new SIPLoyaltyAPI("staging");

// Login the user
await api.login({
   username: "sip",
   password: "password123admin"
})

// Consume rest of the API
await api.searchMerchants({})
```

## Development Instructions: Generate new Typescript Models

1. Whenever the swagger updates, download the new `swagger.json` [from here](https://app.swaggerhub.com/apis/Calibrate/SIP/1.2-oas3/).

   > Download the Unresolved JSON from this link.

2. Save `swagger.json` into the root of the folder.
3. Run `yarn generate:typings` to generate new typings.

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