lukehagar/plex-api

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• 🛠 Make your SDK feel handcrafted by customizing it
• ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• 🎁 Publish your SDK to package managers by configuring automatic publishing
• ✨ When ready to productionize, delete this section from the README

SDK Installation

Composer

To install the SDK first add the below to your composer.json file:

{
    "repositories": [
        {
            "type": "github",
            "url": "https://github.com/LukeHagar/plexphp.git"
        }
    ],
    "require": {
        "lukehagar/plex-api": "*"
    }
}

Then run the following command:

composer update

SDK Example Usage

Example

<?php

declare(strict_types=1);
require_once 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity($security)
    ->build();

try {
    $response = $sdk->server->getServerCapabilities();

    if ($response->twoHundredApplicationJsonObject !== null) {
        // handle response
    }
} catch (Exception $e) {
    // handle exception
}

Available Resources and Operations

Server

• getServerCapabilities - Server Capabilities
• getServerPreferences - Get Server Preferences
• getAvailableClients - Get Available Clients
• getDevices - Get Devices
• getServerIdentity - Get Server Identity
• getMyPlexAccount - Get MyPlex Account
• getResizedPhoto - Get a Resized Photo
• getServerList - Get Server List

Media

• markPlayed - Mark Media Played
• markUnplayed - Mark Media Unplayed
• updatePlayProgress - Update Media Play Progress

Activities

• getServerActivities - Get Server Activities
• cancelServerActivities - Cancel Server Activities

Butler

• getButlerTasks - Get Butler tasks
• startAllTasks - Start all Butler tasks
• stopAllTasks - Stop all Butler tasks
• startTask - Start a single Butler task
• stopTask - Stop a single Butler task

Hubs

• getGlobalHubs - Get Global Hubs
• getLibraryHubs - Get library specific hubs

Search

• performSearch - Perform a search
• performVoiceSearch - Perform a voice search
• getSearchResults - Get Search Results

Library

• getFileHash - Get Hash Value
• getRecentlyAdded - Get Recently Added
• getLibraries - Get All Libraries
• getLibrary - Get Library Details
• deleteLibrary - Delete Library Section
• getLibraryItems - Get Library Items
• refreshLibrary - Refresh Library
• getLatestLibraryItems - Get Latest Library Items
• getCommonLibraryItems - Get Common Library Items
• getMetadata - Get Items Metadata
• getMetadataChildren - Get Items Children
• getOnDeck - Get On Deck

Log

• logLine - Logging a single line message.
• logMultiLine - Logging a multi-line message
• enablePaperTrail - Enabling Papertrail

Playlists

• createPlaylist - Create a Playlist
• getPlaylists - Get All Playlists
• getPlaylist - Retrieve Playlist
• deletePlaylist - Deletes a Playlist
• updatePlaylist - Update a Playlist
• getPlaylistContents - Retrieve Playlist Contents
• clearPlaylistContents - Delete Playlist Contents
• addPlaylistContents - Adding to a Playlist
• uploadPlaylist - Upload Playlist

Security

• getTransientToken - Get a Transient Token.
• getSourceConnectionInformation - Get Source Connection Information

Sessions

• getSessions - Get Active Sessions
• getSessionHistory - Get Session History
• getTranscodeSessions - Get Transcode Sessions
• stopTranscodeSession - Stop a Transcode Session

Updater

• getUpdateStatus - Querying status of updates
• checkForUpdates - Checking for updates
• applyUpdates - Apply Updates

Video

• startUniversalTranscode - Start Universal Transcode
• getTimeline - Get the timeline for a media item

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	http://10.10.10.47:32400	None
1	{protocol}://{ip}:{port}	protocol (default is http), ip (default is 10.10.10.47), port (default is 32400)

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

• protocol: ServerProtocol
• ip: string
• port: string

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy