LukeParke/plexpy
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexpy.git synced 2025-12-06 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4

Browse Source
This commit is contained in:
speakeasybot
2025-03-08 00:02:38 +00:00
parent aeb8aa9fdb
commit 9382496b13
68 changed files with 856 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/models/operations/gettokendetailsuserplexaccount.md
View File

@@ -27,7 +27,6 @@ Logged in user details
| `services` | List[[operations.Services](../../models/operations/services.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.Subscription](../../models/operations/subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | List[[operations.GetTokenDetailsSubscription](../../models/operations/gettokendetailssubscription.md)] | :heavy_check_mark: | N/A | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
@@ -47,4 +46,5 @@ Logged in user details
| `protected` | *Optional[bool]* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | List[*str*] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `subscriptions` | List[[operations.GetTokenDetailsSubscription](../../models/operations/gettokendetailssubscription.md)] | :heavy_minus_sign: | N/A | |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |

2
docs/models/operations/postuserssignindatauserplexaccount.md
View File

@@ -27,7 +27,6 @@ Returns the user account data with a valid auth token
| `services` | List[[operations.PostUsersSignInDataServices](../../models/operations/postuserssignindataservices.md)] | :heavy_check_mark: | N/A | |
| `subscription` | [operations.PostUsersSignInDataSubscription](../../models/operations/postuserssignindatasubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `subscription_description` | *Nullable[str]* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `subscriptions` | List[[operations.PostUsersSignInDataAuthenticationSubscription](../../models/operations/postuserssignindataauthenticationsubscription.md)] | :heavy_check_mark: | N/A | |
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `username` | *str* | :heavy_check_mark: | The account username | Username |
@@ -49,4 +48,5 @@ Returns the user account data with a valid auth token
| `protected` | *Optional[bool]* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `roles` | List[*str*] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `subscriptions` | List[[operations.PostUsersSignInDataAuthenticationSubscription](../../models/operations/postuserssignindataauthenticationsubscription.md)] | :heavy_minus_sign: | N/A | |
| `two_factor_enabled` | *Optional[bool]* | :heavy_minus_sign: | If two-factor authentication is enabled | |

2
docs/sdks/activities/README.md
View File

@@ -26,6 +26,7 @@ Get Server Activities
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -66,6 +67,7 @@ Cancel Server Activities
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

4
docs/sdks/authentication/README.md
View File

@@ -24,6 +24,7 @@ This endpoint provides the caller with a temporary token with the same access le
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -68,6 +69,7 @@ Note: requires Plex Media Server >= 1.15.4.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -109,6 +111,7 @@ Get the User data from the provided X-Plex-Token
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -150,6 +153,7 @@ Sign in user with username and password and return user data with Plex authentic
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.authentication.post_users_sign_in_data(request={

5
docs/sdks/butler/README.md
View File

@@ -23,6 +23,7 @@ Returns a list of butler tasks
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -68,6 +69,7 @@ This endpoint will attempt to start all Butler tasks that are enabled in the set
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -109,6 +111,7 @@ This endpoint will stop all currently running tasks and remove any scheduled tas
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -155,6 +158,7 @@ This endpoint will attempt to start a single Butler task that is enabled in the
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -198,6 +202,7 @@ This endpoint will stop a currently running task by name, or remove it from the
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

3
docs/sdks/hubs/README.md
View File

@@ -21,6 +21,7 @@ Get Global Hubs filtered by the parameters provided.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -65,6 +66,7 @@ This endpoint will return the recently added content.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -109,6 +111,7 @@ This endpoint will return a list of library specific hubs
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

17
docs/sdks/library/README.md
View File

@@ -35,6 +35,7 @@ This resource returns hash values for local files
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -79,6 +80,7 @@ This endpoint will return the recently added content.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -144,6 +146,7 @@ This allows a client to provide a rich interface around the media (e.g. allow so
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -223,6 +226,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -265,6 +269,7 @@ Delete a library using a specific section id
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -328,6 +333,7 @@ Fetches details from a specific section of the library identified by a section k
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -375,6 +381,7 @@ Retrieves a list of all general media data for this library.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -421,6 +428,7 @@ This endpoint Refreshes all the Metadata of the library.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -482,6 +490,7 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -526,6 +535,7 @@ Retrieves a list of all the genres that are found for the media in this library.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -570,6 +580,7 @@ Retrieves a list of all the countries that are found for the media in this libra
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -614,6 +625,7 @@ Retrieves a list of all the actors that are found for the media in this library.
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -658,6 +670,7 @@ Search the provided query across all library sections, or a single section, and
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -706,6 +719,7 @@ This endpoint will return all the (meta)data of a library item specified with by
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -763,6 +777,7 @@ This endpoint will return the children of of a library item specified with the r
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -807,6 +822,7 @@ This endpoint will return the top watched content from libraries of a certain ty
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -850,6 +866,7 @@ This endpoint will return the on deck content.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

9
docs/sdks/log/README.md
View File

@@ -23,6 +23,7 @@ This endpoint will write a single-line log message, including a level and source
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -87,13 +88,14 @@ Ensure each parameter is properly URL-encoded to avoid interpretation issues.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" +
"level=3&message=Test%20message%202&source=postman\n" +
"level=1&message=Test%20message%203&source=postman")
res = plex_api.log.log_multi_line(request=("level=4&message=Test%20message%201&source=postman\n"
"level=3&message=Test%20message%202&source=postman\n"
"level=1&message=Test%20message%203&source=postman"))
assert res is not None
@@ -131,6 +133,7 @@ This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

5
docs/sdks/media/README.md
View File

@@ -23,6 +23,7 @@ This will mark the provided media key as Played.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -64,6 +65,7 @@ This will mark the provided media key as Unplayed.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -106,6 +108,7 @@ This API command can be used to update the play progress of a media item.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -149,6 +152,7 @@ Gets the banner image of the media item
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -197,6 +201,7 @@ Gets the thumbnail image of the media item
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

9
docs/sdks/playlists/README.md
View File

@@ -34,6 +34,7 @@ Create a new playlist. By default the playlist is blank. To create a playlist al
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -80,6 +81,7 @@ Get All Playlists given the specified filters.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -124,6 +126,7 @@ Smart playlist details contain the `content` attribute. This is the content URI
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -166,6 +169,7 @@ This endpoint will delete a playlist
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -208,6 +212,7 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -256,6 +261,7 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -299,6 +305,7 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -342,6 +349,7 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -387,6 +395,7 @@ Imports m3u playlists by passing a path on the server to scan for m3u-formatted
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

7
docs/sdks/plex/README.md
View File

@@ -25,6 +25,7 @@ Get Companions Data
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -66,6 +67,7 @@ Get friends of provided auth token.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -107,6 +109,7 @@ Returns the geolocation and locale data of the caller
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.plex.get_geo_data()
@@ -146,6 +149,7 @@ Retrieves the home data for the authenticated user, including details like home
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -186,6 +190,7 @@ Get Plex server access tokens and server connections
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -231,6 +236,7 @@ Retrieve a Pin ID from Plex.tv to use for authentication flows
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.plex.get_pin(request={
@@ -276,6 +282,7 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.plex.get_token_by_pin_id(request={

3
docs/sdks/search/README.md
View File

@@ -33,6 +33,7 @@ This request is intended to be very fast, and called as the user types.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -80,6 +81,7 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -123,6 +125,7 @@ This will search the database for the string provided.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

9
docs/sdks/server/README.md
View File

@@ -27,6 +27,7 @@ Get Server Capabilities
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -67,6 +68,7 @@ Get Server Preferences
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -107,6 +109,7 @@ Get Available Clients
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -147,6 +150,7 @@ Get Devices
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -187,6 +191,7 @@ This request is useful to determine if the server is online or offline
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.server.get_server_identity()
@@ -224,6 +229,7 @@ Returns MyPlex Account Information
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -266,6 +272,7 @@ Plex's Photo transcoder is used throughout the service to serve images at specif
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -315,6 +322,7 @@ Retrieves media providers and their features from the Plex server.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -356,6 +364,7 @@ Get Server List
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

4
docs/sdks/sessions/README.md
View File

@@ -22,6 +22,7 @@ This will retrieve the "Now Playing" Information of the PMS.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -62,6 +63,7 @@ This will Retrieve a listing of all history views.
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -106,6 +108,7 @@ Get Transcode Sessions
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -146,6 +149,7 @@ Stop a Transcode Session
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

3
docs/sdks/statistics/README.md
View File

@@ -21,6 +21,7 @@ This will return the media statistics for the server
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -62,6 +63,7 @@ This will return the resources for the server
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -103,6 +105,7 @@ This will return the bandwidth statistics for the server
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

3
docs/sdks/updater/README.md
View File

@@ -22,6 +22,7 @@ Querying status of updates
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -63,6 +64,7 @@ Checking for updates
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -106,6 +108,7 @@ Note that these two parameters are effectively mutually exclusive. The `tonight`
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

1
docs/sdks/users/README.md
View File

@@ -16,6 +16,7 @@ Get list of all users that are friends and have library access with the provided
```python
from plex_api_client import PlexAPI
with PlexAPI() as plex_api:
res = plex_api.users.get_users(request={

2
docs/sdks/video/README.md
View File

@@ -21,6 +21,7 @@ Get the timeline for a media item
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
@@ -73,6 +74,7 @@ Begin a Universal Transcode Session
```python
from plex_api_client import PlexAPI
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

1
docs/sdks/watchlist/README.md
View File

@@ -20,6 +20,7 @@ Get User Watchlist
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api: