mstaniuk / ring-sdk

Ring SDK

The One API Typescript wrapper

Installing

Using npm:

npm install ring-api

Using yarn:

yarn add ring-api

Usage

Obtain an API key

For more information on how to obtain an API key, visit The One API

Create a client

import { getClient } from 'ring-api';
// ...
const client = getClient({API_KEY: 'xxx'});

Modules

Movie

Get a list of all movies in the API

const movies = await client.movie.getAll();

Get a specific movie by ID

const movie = await client.movie.getById('5cd95395de30eff6ebccde5c');

Get a list of all quotes in a movie

const quotes = await client.movie.getQuoteById('5cd95395de30eff6ebccde5c');

Quote

Get a list of all quotes in the API

const movies = await client.quote.getAll();

Get a specific quote by ID

const movie = await client.quote.getById('5cd96e05de30eff6ebcce917');

Testing

npm run test