LukeParke/plexphp

Fork 0

mirror of https://github.com/LukeHagar/plexphp.git synced 2025-12-06 04:20:51 +00:00

Files

speakeasybot 7602b83131 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.399.2

2024-09-19 00:11:28 +00:00

16 KiB

Raw Blame History

Server

Overview

Operations against the Plex Media Server System.

Available Operations

getServerCapabilities - Get 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
getMediaProviders - Get Media Providers
getServerList - Get Server List

getServerCapabilities

Get Server Capabilities

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetServerCapabilitiesResponse

Errors

Error Object	Status Code	Content Type
Errors\GetServerCapabilitiesBadRequest	400	application/json
Errors\GetServerCapabilitiesUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getServerPreferences

Get Server Preferences

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetServerPreferencesResponse

Errors

Error Object	Status Code	Content Type
Errors\GetServerPreferencesBadRequest	400	application/json
Errors\GetServerPreferencesUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getAvailableClients

Get Available Clients

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetAvailableClientsResponse

Errors

Error Object	Status Code	Content Type
Errors\GetAvailableClientsBadRequest	400	application/json
Errors\GetAvailableClientsUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getDevices

Get Devices

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetDevicesResponse

Errors

Error Object	Status Code	Content Type
Errors\GetDevicesBadRequest	400	application/json
Errors\GetDevicesUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getServerIdentity

This request is useful to determine if the server is online or offline

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->build();

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

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

Response

?Operations\GetServerIdentityResponse

Errors

Error Object	Status Code	Content Type
Errors\GetServerIdentityRequestTimeout	408	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getMyPlexAccount

Returns MyPlex Account Information

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetMyPlexAccountResponse

Errors

Error Object	Status Code	Content Type
Errors\GetMyPlexAccountBadRequest	400	application/json
Errors\GetMyPlexAccountUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getResizedPhoto

Plex's Photo transcoder is used throughout the service to serve images at specified sizes.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

try {
    $request = new Operations\GetResizedPhotoRequest(
        width: 110,
        height: 165,
        opacity: 643869,
        blur: 0,
        minSize: Operations\MinSize::Zero,
        upscale: Operations\Upscale::One,
        url: '/library/metadata/49564/thumb/1654258204',
    );
    $response = $sdk->server->getResizedPhoto($request);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
`$request`	Operations\GetResizedPhotoRequest	✔️	The request object to use for the request.

Response

?Operations\GetResizedPhotoResponse

Errors

Error Object	Status Code	Content Type
Errors\GetResizedPhotoBadRequest	400	application/json
Errors\GetResizedPhotoUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getMediaProviders

Retrieves media providers and their features from the Plex server.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

try {

    $response = $sdk->server->getMediaProviders('CV5xoxjTpFKUzBTShsaf');

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

Parameters

Parameter	Type	Required	Description	Example
`xPlexToken`	string	✔️	Plex Authentication Token	CV5xoxjTpFKUzBTShsaf

Response

?Operations\GetMediaProvidersResponse

Errors

Error Object	Status Code	Content Type
Errors\GetMediaProvidersBadRequest	400	application/json
Errors\GetMediaProvidersUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getServerList

Get Server List

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setClientID('gcgzw5rz2xovp84b4vha3a40')
    ->setClientName('Plex Web')
    ->setClientVersion('4.133.0')
    ->setClientPlatform('Chrome')
    ->setDeviceName('Linux')
    ->setSecurity($security)->build();

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

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

Response

?Operations\GetServerListResponse

Errors

Error Object	Status Code	Content Type
Errors\GetServerListBadRequest	400	application/json
Errors\GetServerListUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

16 KiB Raw Blame History

Server

Overview

Available Operations

getServerCapabilities

Example Usage

Response

Errors

getServerPreferences

Example Usage

Response

Errors

getAvailableClients

Example Usage

Response

Errors

getDevices

Example Usage

Response

Errors

getServerIdentity

Example Usage

Response

Errors

getMyPlexAccount

Example Usage

Response

Errors

getResizedPhoto

Example Usage

Parameters

Response

Errors

getMediaProviders

Example Usage

Parameters

Response

Errors

getServerList

Example Usage

Response

Errors

16 KiB

Raw Blame History