README

This is the documentation for the Overseerr API backend. Two primary authentication methods are supported: - Cookie Authentication: A valid sign-in to the /auth/plex or /auth/local will generate a valid authentication cookie. - API Key Authentication: Sign-in is also possible by passing an X-Api-Key header along with a valid API Key generated by Overseerr.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\AuthApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\AuthLocalBody(); // \Swagger\Client\Model\AuthLocalBody | 

try {
    $result = $apiInstance->authLocalPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authLocalPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: apiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');
// Configure API key authorization: cookieAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('connect.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('connect.sid', 'Bearer');

$apiInstance = new Swagger\Client\Api\AuthApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->authLogoutPost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authLogoutPost: ', $e->getMessage(), PHP_EOL;
}

// Configure API key authorization: apiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');
// Configure API key authorization: cookieAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('connect.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('connect.sid', 'Bearer');

$apiInstance = new Swagger\Client\Api\AuthApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->authMeGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authMeGet: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\AuthApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\AuthPlexBody(); // \Swagger\Client\Model\AuthPlexBody | 

try {
    $result = $apiInstance->authPlexPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->authPlexPost: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to {server}/api/v1

Documentation For Models

• AnyOfMediaRequestModifiedBy
• AnyOfinlineResponse20014ResultsItems
• AuthLocalBody
• AuthPlexBody
• AuthResetpasswordBody
• Cast
• Collection
• CreditCast
• CreditCrew
• Crew
• DiscordSettings
• DiscordSettingsOptions
• Episode
• ExternalIds
• Genre
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20010Movie
• InlineResponse20011
• InlineResponse20012
• InlineResponse20013
• InlineResponse20014
• InlineResponse20015
• InlineResponse20016
• InlineResponse20017
• InlineResponse20018
• InlineResponse20019
• InlineResponse2002
• InlineResponse20020
• InlineResponse20021
• InlineResponse20022
• InlineResponse20023
• InlineResponse20024
• InlineResponse20025
• InlineResponse20026
• InlineResponse20027
• InlineResponse20028
• InlineResponse20029
• InlineResponse2003
• InlineResponse20030
• InlineResponse20031
• InlineResponse20032
• InlineResponse20033
• InlineResponse20034
• InlineResponse20035
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• Issue
• IssueBody
• IssueComment
• IssueCommentCommentIdBody
• IssueIdCommentBody
• Job
• JobIdScheduleBody
• Keyword
• LunaSeaSettings
• LunaSeaSettingsOptions
• MainSettings
• MediaIdStatusBody
• MediaInfo
• MediaRequest
• MovieDetails
• MovieDetailsCollection
• MovieDetailsCredits
• MovieDetailsProductionCountries
• MovieDetailsReleases
• MovieDetailsReleasesReleaseDates
• MovieDetailsReleasesResults
• MovieResult
• Network
• NotificationAgentTypes
• NotificationEmailSettings
• NotificationEmailSettingsOptions
• OneOfPersonResultKnownForItems
• PageInfo
• PersonDetail
• PersonResult
• PlexConnection
• PlexDevice
• PlexLibrary
• PlexSettings
• PlexSyncBody
• ProductionCompany
• PublicSettings
• PushbulletSettings
• PushbulletSettingsOptions
• PushoverSettings
• PushoverSettingsOptions
• RadarrSettings
• RadarrTestBody
• RelatedVideo
• RequestBody
• ResetpasswordGuidBody
• Season
• ServarrTag
• ServiceProfile
• SettingsMainBody
• SettingsPasswordBody
• SettingsPermissionsBody
• SettingscacheStats
• SlackSettings
• SlackSettingsOptions
• SonarrSeries
• SonarrSeriesAddOptions
• SonarrSeriesImages
• SonarrSeriesRatings
• SonarrSeriesSeasons
• SonarrSettings
• SonarrTestBody
• SpokenLanguage
• TelegramSettings
• TelegramSettingsOptions
• TvDetails
• TvDetailsContentRatings
• TvDetailsContentRatingsResults
• TvDetailsCreatedBy
• TvResult
• User
• UserBody
• UserBody1
• UserRegisterPushSubscriptionBody
• UserSettings
• UserSettingsNotifications
• WatchProviderDetails
• WatchProviders
• WatchProvidersInner
• WebPushSettings
• WebhookSettings
• WebhookSettingsOptions

Documentation For Authorization

apiKey

• Type: API key
• API key parameter name: X-Api-Key
• Location: HTTP header

cookieAuth

• Type: API key
• API key parameter name: connect.sid
• Location: URL query string

Author