Lord of the Rings SDK

The one API to rule them all.

Installation

npm install --save lord-of-rings-sdk-js

Usage

The SDK requires an API token to authorize the requests. You can get one by signing up at https://the-one-api.dev.

Create a new instance of the LordOfTheRingsSDK.

new LordOfTheRingsSDK(requestConfig: { apiVersion?: "v1" | "v2"; apiToken: string });

Parameters

• requestConfig - An object containing the following properties:
  • apiVersion (optional) - The version of the API to use. Can be either "v1" or "v2". Defaults to "v1".
  • apiToken - The API token to authenticate the requests.

Example

const LOTR = require("lord-of-the-rings-sdk");

const lordOfTheRings = new LOTR({
  apiToken: "xxxx",
  apiVersion: "v2",
});

Movie Resources

Methods

• list

  Retrieve a list of movies.

  movie.list(params?: ListParams): Promise<{
    docs: Movie[];
    meta: Meta;
  }>;

  Parameters:

  • params (optional) - An object containing the following properties:
    • limit (optional) - The maximum number of items to return in a single request.
    • offset (optional) - The number of items to skip before starting to collect the result set.
    • sort (optional) - The field by which the data should be sorted.
    • order (optional) - The order in which the data should be sorted (e.g., "asc" for ascending or "desc" for descending).
    • filter (optional) - A filter to apply to the data.

  Example:

  const movies = await lordOfTheRings.movie.list({
    limit: 2,
    offset: 0,
    pages: 1,
    filter: "budgetInMillions<100",
  });

• get

  Retrieve a single movie by ID.

  movie.get(id: string): Promise<{
    docs: Movie[];
    meta: Meta;
  }>;

  Parameters:

  • id - The ID of the movie to retrieve.

  Example:

  const movie = await lordOfTheRings.movie.get("5cd95395de30eff6ebccde5c");

• getQuote

  Get quotes from a specific movie.

  movie.getQuotes(id: string): Promise<{
    docs: Quote[];
    meta: Meta;
  }>;

  Parameters

  • id - The ID of the movie to retrieve quotes from.

  Example:

  const quotes = await lordOfTheRings.movie.getQuotes(
    "5cd95395de30eff6ebccde5c"
  );

Quote Resources

Methods

• list

  Retrieve a list of quotes.

  quote.list(params?: ListParams): Promise<{
    docs: Quote[];
    meta: Meta;
  }>;

  Parameters:

  • params (optional) - An object containing the following properties:
    • limit (optional) - The maximum number of items to return in a single request.
    • offset (optional) - The number of items to skip before starting to collect the result set.
    • sort (optional) - The field by which the data should be sorted.
    • order (optional) - The order in which the data should be sorted (e.g., "asc" for ascending or "desc" for descending).
    • filter (optional) - A filter to apply to the data.

  Example:

  const quotes = await lordOfTheRings.quote.list({
    limit: 2,
    offset: 0,
    pages: 1,
  });

• get

  Retrieve a single quote by ID.

  quote.get(id: string): Promise<{
    docs: Quote[];
    meta: Meta;
  }>;

  Parameters:

  • id - The ID of the quote to retrieve.

  Example:

  const quote = await lordOfTheRings.quote.get("5cd96e05de30eff6ebccfe95");

Testing

To run the tests, run the following command:

npm run test

The tests are written using Jest. (More tests can be added to improve the coverage.)

Credits: ChatGPT for improving the documentation.