mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.0
This commit is contained in:
speakeasybot
10
docs/models/errors/getstatisticserrors.md
Normal file
10
docs/models/errors/getstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getstatisticsresponsebody.md
Normal file
11
docs/models/errors/getstatisticsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetStatisticsErrors](../../models/errors/getstatisticserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
15
docs/models/operations/account.md
Normal file
15
docs/models/operations/account.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Account
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 238960586 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | N/A | /accounts/238960586 |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | Diane |
|
||||
| `default_audio_language` | *Optional[str]* | :heavy_minus_sign: | N/A | en |
|
||||
| `auto_select_audio` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `default_subtitle_language` | *Optional[str]* | :heavy_minus_sign: | N/A | en |
|
||||
| `subtitle_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |
|
||||
@@ -7,8 +7,8 @@
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `width` | *float* | :heavy_check_mark: | The width for the resized photo | 110 |
|
||||
| `height` | *float* | :heavy_check_mark: | The height for the resized photo | 165 |
|
||||
| `opacity` | *int* | :heavy_check_mark: | The opacity for the resized photo | |
|
||||
| `blur` | *float* | :heavy_check_mark: | The width for the resized photo | 0 |
|
||||
| `min_size` | [operations.MinSize](../../models/operations/minsize.md) | :heavy_check_mark: | images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against. | |
|
||||
| `upscale` | [operations.Upscale](../../models/operations/upscale.md) | :heavy_check_mark: | allow images to be resized beyond native dimensions. | |
|
||||
| `url` | *str* | :heavy_check_mark: | path to image within Plex | /library/metadata/49564/thumb/1654258204 |
|
||||
| `url` | *str* | :heavy_check_mark: | path to image within Plex | /library/metadata/49564/thumb/1654258204 |
|
||||
| `opacity` | *int* | :heavy_check_mark: | The opacity for the resized photo | |
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 161 |
|
||||
| `setting` | List[[Union[operations.One, operations.Two]](../../models/operations/setting.md)] | :heavy_minus_sign: | N/A | [{"advanced":false,"default":"","group":"general","hidden":false,"id":"FriendlyName","label":"Friendly name","summary":"This name will be used to identify this media server to other computers on your network. If you leave it blank, your computer's name will be used instead.","type":"text","value":"Hera"},{"advanced":false,"default":3600,"enumValues":"900:every 15 minutes\|1800:every 30 minutes\|3600:hourly\|7200:every 2 hours\|21600:every 6 hours\|43200:every 12 hours\|86400:daily","group":"library","hidden":false,"id":"ScheduledLibraryUpdateInterval","label":"Library scan interval","summary":"","type":"int","value":3600}] |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 161 |
|
||||
| `setting` | List[[operations.Setting](../../models/operations/setting.md)] | :heavy_minus_sign: | N/A | [{"advanced":false,"default":false,"enumValues":"1:admin only\|2:everyone","group":"","hidden":true,"id":"EnableDatabaseTrace","label":"","summary":"","type":"bool","value":false}] |
|
||||
12
docs/models/operations/getstatisticsdevice.md
Normal file
12
docs/models/operations/getstatisticsdevice.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetStatisticsDevice
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | N/A | 208 |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | N/A | Roku Express |
|
||||
| `platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Roku |
|
||||
| `client_identifier` | *Optional[str]* | :heavy_minus_sign: | N/A | 793095d235660625108ef785cc7646e9 |
|
||||
| `created_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1706470556 |
|
||||
@@ -1,17 +1,11 @@
|
||||
# Two
|
||||
# GetStatisticsMediaContainer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | ScheduledLibraryUpdateInterval |
|
||||
| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | Library scan interval |
|
||||
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | int |
|
||||
| `default` | *Optional[int]* | :heavy_minus_sign: | N/A | 3600 |
|
||||
| `value` | *Optional[int]* | :heavy_minus_sign: | N/A | 3600 |
|
||||
| `hidden` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `advanced` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `group` | *Optional[str]* | :heavy_minus_sign: | N/A | library |
|
||||
| `enum_values` | *Optional[str]* | :heavy_minus_sign: | N/A | 900:every 15 minutes\|1800:every 30 minutes\|3600:hourly\|7200:every 2 hours\|21600:every 6 hours\|43200:every 12 hours\|86400:daily |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | N/A | 5497 |
|
||||
| `device` | List[[operations.GetStatisticsDevice](../../models/operations/getstatisticsdevice.md)] | :heavy_minus_sign: | N/A | [{"clientIdentifier":"793095d235660625108ef785cc7646e9","createdAt":1706470556,"id":208,"name":"Roku Express","platform":"Roku"}] |
|
||||
| `account` | List[[operations.Account](../../models/operations/account.md)] | :heavy_minus_sign: | N/A | [{"autoSelectAudio":true,"defaultAudioLanguage":"en","defaultSubtitleLanguage":"en","id":238960586,"key":"/accounts/238960586","name":"Diane","subtitleMode":1,"thumb":"https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"}] |
|
||||
| `statistics_media` | List[[operations.StatisticsMedia](../../models/operations/statisticsmedia.md)] | :heavy_minus_sign: | N/A | [{"accountID":1,"at":1707141600,"count":1,"deviceID":13,"duration":1555,"metadataType":4,"timespan":4}] |
|
||||
8
docs/models/operations/getstatisticsrequest.md
Normal file
8
docs/models/operations/getstatisticsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetStatisticsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | 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/> |
|
||||
11
docs/models/operations/getstatisticsresponse.md
Normal file
11
docs/models/operations/getstatisticsresponse.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetStatisticsResponse
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [Optional[operations.GetStatisticsResponseBody]](../../models/operations/getstatisticsresponsebody.md) | :heavy_minus_sign: | Media Statistics |
|
||||
10
docs/models/operations/getstatisticsresponsebody.md
Normal file
10
docs/models/operations/getstatisticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetStatisticsResponseBody
|
||||
|
||||
Media Statistics
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `media_container` | [Optional[operations.GetStatisticsMediaContainer]](../../models/operations/getstatisticsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,16 +0,0 @@
|
||||
# One
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | FriendlyName |
|
||||
| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | Friendly name |
|
||||
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | This name will be used to identify this media server to other computers on your network. If you leave it blank, your computer's name will be used instead. |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | text |
|
||||
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `value` | *Optional[str]* | :heavy_minus_sign: | N/A | Hera |
|
||||
| `hidden` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `advanced` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `group` | *Optional[str]* | :heavy_minus_sign: | N/A | general |
|
||||
@@ -1,17 +1,17 @@
|
||||
# Setting
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### One
|
||||
|
||||
```python
|
||||
setting: operations.One = /* values here */
|
||||
```
|
||||
|
||||
### Two
|
||||
|
||||
```python
|
||||
setting: operations.Two = /* values here */
|
||||
```
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `id` | *Optional[str]* | :heavy_minus_sign: | N/A | EnableDatabaseTrace |
|
||||
| `label` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `summary` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | bool |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `value` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `hidden` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `advanced` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `group` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `enum_values` | *Optional[str]* | :heavy_minus_sign: | N/A | 1:admin only\|2:everyone |
|
||||
14
docs/models/operations/statisticsmedia.md
Normal file
14
docs/models/operations/statisticsmedia.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# StatisticsMedia
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `account_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `device_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 13 |
|
||||
| `timespan` | *Optional[int]* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1707141600 |
|
||||
| `metadata_type` | *Optional[int]* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 1555 |
|
||||
@@ -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
|
||||
|
||||
@@ -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>",
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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>",
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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>",
|
||||
|
||||
@@ -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>",
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
49
docs/sdks/statistics/README.md
Normal 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 | */* |
|
||||
@@ -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 | */* |
|
||||
|
||||
Reference in New Issue
Block a user