README

An object-oriented PHP wrapper for the Overseerr API

Requirements

Install

Via Composer

composer require owenvoke/overseerr guzzlehttp/guzzle:^7.5 http-interop/http-factory-guzzle:^1.2

We are decoupled from any HTTP messaging client with help by HTTPlug.

Usage

Documentation

See the docs directory for more detailed documentation.

Basic usage

// Include the Composer autoloader
require_once __DIR__ . '/vendor/autoload.php';

$client = new \OwenVoke\Overseerr\Client('https://your-overseer-url.com');
$repositories = $client->status()->status();

Authentication

Note: The Overseerr API only supports authentication via an API token.

use OwenVoke\Overseerr\Client;
use OwenVoke\Overseerr\Enums\AuthMethod;

$client = new Client();
$client->authenticate($apiToken);

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.

owenvoke / overseerr

Maintainers

Details