# ring-sdk

> SDK for the rings api

Latest version **1.0.14** (published 2023-06-01) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install ring-sdk
pnpm add ring-sdk
yarn add ring-sdk
bun add ring-sdk
```

## 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.14 |
| Published | 2023-06-01 |
| First published | 2023-06-01 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | 19.8.1 |
| Dependencies | 1 |
| Unpacked size | 21 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Sanni |
| Maintainers | tomiwatech |
| Keywords | typescript, template |

## Links

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

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.4.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.14 (latest) — 2023-06-01
- 1.0.13 — 2023-06-01
- 1.0.12 — 2023-06-01
- 1.0.11 — 2023-06-01
- 1.0.10 — 2023-06-01
- 1.0.9 — 2023-06-01
- 1.0.8 — 2023-06-01
- 1.0.7 — 2023-06-01
- 1.0.6 — 2023-06-01
- 1.0.5 — 2023-06-01
- 1.0.4 — 2023-06-01
- 1.0.3 — 2023-06-01
- 1.0.2 — 2023-06-01
- 1.0.1 — 2023-06-01
- 1.0.0 — 2023-06-01

## README

# Ring SDK

The Ring SDK is a Typescript library that provides a convenient interface for interacting with the Ring API. It allows you to fetch movie and quote data from the API and perform various operations.

## Installation

To use the Ring SDK in your project, you can install it via npm:

`npm install ring-sdk`

## Test

To run the tests

`npm run test`

## Usage

Here's an example of how to use the Ring SDK in your JavaScript/TypeScript code:

```javascript
import { RingSDK } from "ring-sdk";

// Create an instance of the SDK
const client = new RingSDK("https://api.example.com", {
  headers: {
    Authorization: "Bearer your_token",
  },
});

// Example usage with async/await
(async () => {
  try {
    const movies = await client.movies.getAllMovies();
    console.log("Movies:", movies);
  } catch (error) {
    console.error("Error:", error);
  }

  try {
    const quotes = await client.quotes.getAllQuotes();
    console.log("Quotes:", quotes);
  } catch (error) {
    console.error("Error:", error);
  }
})();

// Example usage using promises
client.movies
  .getAllMovies()
  .then((movies) => {
    console.log("Movies:", movies);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

client.quotes
  .getAllQuotes()
  .then((quotes) => {
    console.log("Quotes:", quotes);
  })
  .catch((error) => {
    console.error("Error:", error);
  });
```

## API Reference

The Ring SDK provides the following classes and methods:

- **RingSDK**: The main class representing the SDK. It has movies and quotes properties to access the movie and quote APIs.

- **MoviesAPI**: A class representing the movie API. It provides methods like getMovieById and getAllMovies to fetch movie data.

- **QuotesAPI**: A class representing the quote API. It provides methods like getQuoteById and getAllQuotes to fetch quote data.

For detailed information about the classes and methods, please refer to the source code and documentation.

## Contributing

Contributions to the Ring SDK are welcome! If you find any issues or have ideas for improvements, feel free to open an issue or submit a pull request on the GitHub repository.

## License

The Ring SDK is open-source and released under the MIT License.

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