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

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.0

Browse Source
This commit is contained in:
speakeasybot
2024-02-23 14:46:40 +00:00
parent 82c1464f73
commit ddf240cdae
97 changed files with 1336 additions and 1037 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -57,14 +57,13 @@ Cancel Server Activities
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.activities.cancel_server_activities(activity_uuid='string')
res = s.activities.cancel_server_activities(activity_uuid='<value>')
if res.status_code == 200:
# handle response

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

@@ -28,7 +28,6 @@ This resource returns hash values for local files
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -218,7 +217,6 @@ Delate a library using a specific section
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -317,7 +315,6 @@ This endpoint Refreshes the library.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -414,7 +411,6 @@ This endpoint will return the metadata of a library item specified with the rati
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -454,7 +450,6 @@ This endpoint will return the children of of a library item specified with the r
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",

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

@@ -20,7 +20,6 @@ This will mark the provided media key as Played.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -59,7 +58,6 @@ This will mark the provided media key as Unplayed.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -99,14 +97,13 @@ This API command can be used to update the play progress of a media item.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.media.update_play_progress(key='string', time=6900.91, state='string')
res = s.media.update_play_progress(key='<value>', time=6900.91, state='<value>')
if res.status_code == 200:
# handle response

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

@@ -39,7 +39,7 @@ s = plex_api.PlexAPI(
)
req = operations.CreatePlaylistRequest(
title='string',
title='<value>',
type=operations.QueryParamType.PHOTO,
smart=operations.Smart.ONE,
uri='https://inborn-brochure.biz',
@@ -119,7 +119,6 @@ Smart playlist details contain the `content` attribute. This is the content URI
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -159,7 +158,6 @@ This endpoint will delete a playlist
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -199,14 +197,13 @@ From PMS version 1.9.1 clients can also edit playlist metadata using this endpoi
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.playlists.update_playlist(playlist_id=3915, title='string', summary='string')
res = s.playlists.update_playlist(playlist_id=3915, title='<value>', summary='<value>')
if res.status_code == 200:
# handle response
@@ -244,7 +241,6 @@ Note that for dumb playlists, items have a `playlistItemID` attribute which is u
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -285,7 +281,6 @@ Clears a playlist, only works with dumb playlists. Returns the playlist.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -326,7 +321,6 @@ With a smart playlist, passing a new `uri` parameter replaces the rules for the
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",

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

@@ -19,14 +19,13 @@ Retrieve a Pin from Plex.tv for authentication flows
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.plex.get_pin(x_plex_client_identifier='string', strong=False)
res = s.plex.get_pin(x_plex_client_identifier='<value>', strong=False)
if res.object is not None:
# handle response
@@ -60,14 +59,13 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.plex.get_token(pin_id='string', x_plex_client_identifier='string')
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='<value>')
if res.status_code == 200:
# handle response

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

@@ -32,7 +32,6 @@ This request is intended to be very fast, and called as the user types.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -77,7 +76,6 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
@@ -118,7 +116,6 @@ This will search the database for the string provided.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",

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

@@ -62,7 +62,6 @@ Note: requires Plex Media Server >= 1.15.4.
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",

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

@@ -227,11 +227,11 @@ s = plex_api.PlexAPI(
req = operations.GetResizedPhotoRequest(
width=110,
height=165,
opacity=643869,
blur=4000,
min_size=operations.MinSize.ZERO,
blur=20,
min_size=operations.MinSize.ONE,
upscale=operations.Upscale.ZERO,
url='/library/metadata/49564/thumb/1654258204',
opacity=209783,
)
res = s.server.get_resized_photo(req)

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

@@ -117,7 +117,6 @@ Stop a Transcode Session
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",

49
docs/sdks/statistics/README.md Normal file
View File

@@ -0,0 +1,49 @@
# Statistics
(*statistics*)
## Overview
API Calls that perform operations with Plex Media Server Statistics
### Available Operations
* [get_statistics](#get_statistics) - Get Media Statistics
## get_statistics
This will return the media statistics for the server
### Example Usage
```python
import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.statistics.get_statistics(timespan=411769)
if res.object is not None:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `timespan` | *Optional[int]* | :heavy_minus_sign: | The timespan to retrieve statistics for<br/>the exact meaning of this parameter is not known<br/> |
### Response
**[operations.GetStatisticsResponse](../../models/operations/getstatisticsresponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.GetStatisticsResponseBody | 401 | application/json |
| errors.SDKError | 4x-5xx | */* |

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

@@ -8,54 +8,8 @@ API Calls that perform operations with Plex Media Server Videos
### Available Operations
* [start_universal_transcode](#start_universal_transcode) - Start Universal Transcode
* [get_timeline](#get_timeline) - Get the timeline for a media item
## start_universal_transcode
Begin a Universal Transcode Session
### Example Usage
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
req = operations.StartUniversalTranscodeRequest(
has_mde=8924.99,
path='/etc/mail',
media_index=9962.95,
part_index=1232.82,
protocol='string',
)
res = s.video.start_universal_transcode(req)
if res.status_code == 200:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `request` | [operations.StartUniversalTranscodeRequest](../../models/operations/startuniversaltranscoderequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[operations.StartUniversalTranscodeResponse](../../models/operations/startuniversaltranscoderesponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.StartUniversalTranscodeResponseBody | 401 | application/json |
| errors.SDKError | 4x-5xx | */* |
* [start_universal_transcode](#start_universal_transcode) - Start Universal Transcode
## get_timeline
@@ -78,7 +32,7 @@ req = operations.GetTimelineRequest(
has_mde=7574.33,
time=3327.51,
duration=7585.39,
context='string',
context='<value>',
play_queue_item_id=1406.21,
play_back_time=2699.34,
row=3536.42,
@@ -107,3 +61,49 @@ if res.status_code == 200:
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetTimelineResponseBody | 401 | application/json |
| errors.SDKError | 4x-5xx | */* |
## start_universal_transcode
Begin a Universal Transcode Session
### Example Usage
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
req = operations.StartUniversalTranscodeRequest(
has_mde=8924.99,
path='/etc/mail',
media_index=9962.95,
part_index=1232.82,
protocol='<value>',
)
res = s.video.start_universal_transcode(req)
if res.status_code == 200:
# handle response
pass
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `request` | [operations.StartUniversalTranscodeRequest](../../models/operations/startuniversaltranscoderequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[operations.StartUniversalTranscodeResponse](../../models/operations/startuniversaltranscoderesponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.StartUniversalTranscodeResponseBody | 401 | application/json |
| errors.SDKError | 4x-5xx | */* |