lord-of-the-rings-api-sdk
v1.0.4
Published
Please modify this readme file to specify how to install, use and test the SDK.
Downloads
5
Readme
Installation
npm install lord-of-the-rings-api-sdk
Usage
Import and initialize a client using an token which you can get from The One API.
const { Client } = require('lord-of-the-rings-api-sdk');
// Initializing a client
const client = new Client(/*API_KEY*/);
Call a method of any service.
See the complete API reference.
(async () => {
const movies = await client.movie.getAll();
})();
Each method returns a Promise
which resolves the response.
API
The Client
has multiple services and each service has its own methods .
const client = new Client(/*API_KEY*/);
// get all movies
const movies = await client.movie.getAll();
// get a movie by its id
const movie = await client.movie.getById(/*MOVIE_ID*/);
// get all quotes of a movie by its id
const quote = await client.movie.getQuotes(/*MOVIE_ID*/);
// get all quotes
const quotes = await client.quote.getAll();
// get a quote by its id
const quote = await client.quote.getById(/*QUOTE_ID*/);
Requirements
This package supports the following minimum versions:
- Runtime:
node >= 12
- Type definitions (optional):
typescript >= 4.5
Earlier versions may still work, but we encourage people building new applications to upgrade to the current stable.
Getting help
If you want to submit a feature request for the SDK, or are experiencing any issues with the API, please email us at [email protected]
.
To report issues with the SDK, it is possible to submit an issue to this repo. However, we don't monitor these issues very closely. We recommend you reach out to us at [email protected]
instead.