christopherwh-theoneapisdk v1.0.0

TheOneAPI SDK

The TheOneAPI SDK is a JavaScript library that provides convenient access to the API described in the documentation at https://the-one-api.dev/documentation#6.

Installation

To install the SDK, you can use npm:

npm install christopherwh-theoneapisdk

Usage

To use the SDK, you need to require/import the TheOneAPI class and create an instance of it.

const TheOneAPI = require('theoneapi-sdk');

const oneAPI = new TheOneAPI();

Retrieving Movies

You can retrieve information about all of the movies using the getMovies method:

oneAPI
  .getMovies()
  .then(movies => {
    // Process the movies data
  })
  .catch(error => {
    // Handle any errors
  });

Retrieving a Movie by ID

You can retrieve information about a specific movie by its ID using the getMovie method:

const movieId = 'MOVIE_ID';
oneAPI
  .getMovie(movieId)
  .then(movie => {
    // Process the movie data
  })
  .catch(error => {
    // Handle any errors
  });

Retrieving Quotes by Movie

You can retrieve quotes from a specific movie by its ID using the getQuotesByMovie method:

const movieId = 'MOVIE_ID';
oneAPI
.getQuotesByMovie(movieId)
  .then(quotes => {
    // Process the quotes data
  })
  .catch(error => {
    // Handle any errors
  });

Retrieving Quotes

You can retrieve quotes from all of the movies using the getQuotes method:

oneAPI
  .getQuotes()
  .then(quotes => {
    // Process the quotes data
  })
  .catch(error => {
    // Handle any errors
  });

Retrieving a Quote

You can retrieve a specific quote by its ID using the getQuote method:

const quoteId = 'QUOTE_ID';
oneAPI
  .getQuote(quoteId)
  .then(quote => {
    // Process the quote data
  })
  .catch(error => {
    // Handle any errors
  });

Using other endpoints

You can utilize all endpoints available with thefetchData method:

const endpoint = '/character';

oneAPI
.fetchData(endpoint)
.then(character => {
    // Process the character data
  })
  .catch(error => {
    // Handle any errors
  });

Additional Parameters

The SDK provides additional parameters to customize the requests. Parameters must be included prior to calling a get or fetch method:

• page(page): Set the page number for pagination.
• limit(limit): Set the maximum number of results per page.
• sort(field, sort): Sort the results by the specified field and order (asc or desc).
• filter(field, value): Filter the results by the specified field and value.
• filterInclude(field, values): Include specific values for a field in the results.
• filterExclude(field, values): Exclude specific values for a field from the results.
• filterRegex(field, value): Filter the results using a regular expression on a specific field.
• filterAmount(field, value): Filter the results based on an amount comparison.

Example:

oneAPI
  .filter('name', 'The Hobbit Series')
  .getMovies()
  .then(responseData => {
    console.log(responseData);
  })
  .catch(error => {
    // Handle any errors
  });