# rc_sdk_gm

> "Redcarpet-sdk"

Latest version **2.0.2** (published 2022-09-01) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2022-09-01 |
| First published | 2022-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Redcarpet Tech |
| Maintainers | youngheart12, redcarpetup |

## Links

- npm: https://www.npmjs.com/package/rc_sdk_gm
- Repository: https://github.com/RedCarpetUp/redcarpet-js-sdk
- Homepage: https://github.com/RedCarpetUp/redcarpet-js-sdk#readme
- Issues: https://github.com/RedCarpetUp/redcarpet-js-sdk/issues
- npm.io page: https://npm.io/package/rc_sdk_gm

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [moment](https://npm.io/package/moment.md) ^2.29.3
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.1.1

## Recent versions

- 2.0.2 (latest) — 2022-09-01
- 2.0.1 — 2022-08-31
- 2.0.0 — 2022-08-29
- 1.1.9 — 2022-08-29
- 1.1.8 — 2022-08-29

## README

# Redcarpet SDK

## Installation

```bash
npm i rc_sdk_gm
```

```bash
yarn add rc_sdk_gm
```
## Documentation

Documentation of Redcarpet API and their usage 

### Basic Usage

Instantiate the redcarpet instance with `apiKey` , `productType` & `productVersion`. You can obtain the keys from the redcarpet website.

```js

const RedcarpetUpAPI = require('rc_sdk_gm');

var instance = new RedcarpetUpAPI({
    productType: "your-product-type",
    apiKey: "your-api-key",
});
```

The resources can be accessed via the instance. All the methods invocations follows the namespaced signature

```js
// API signature
// {redcarpt Instance}.{methodName}

// example
instance.getOtp({
    phone:'XXXXXXXXXX'
});
```

Every resource method returns a promise.

```js
instance.verifyOtp({
    phone: 'XXXXXXXXXX',
    otp: '234343',
  })
  .then(response => {
    // handle success
  })
  .catch(error => {
    // handle error
  });
```

## Licence

MIT Licensed. See [LICENSE.txt](LICENSE.txt) for more details

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