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.476.0

Browse Source
This commit is contained in:
speakeasybot
2025-01-25 00:02:55 +00:00
parent f1f4ba1876
commit fcf010c65b
56 changed files with 2230 additions and 1184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/models/operations/enablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,11 @@
# EnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `DISABLED` | 0 |

12
docs/models/operations/episodesort.md Normal file
View File

@@ -0,0 +1,12 @@
# EpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `OLDEST_FIRST` | 0 |
| `NEWEST_FIRST` | 1 |

11
docs/models/operations/flattenseasons.md
View File

@@ -1,9 +1,12 @@
# FlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `HIDE` | 0 |
| `SHOW` | 1 |

11
docs/models/operations/getlibraryitemsenablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,11 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `DISABLED` | 0 |

12
docs/models/operations/getlibraryitemsepisodesort.md Normal file
View File

@@ -0,0 +1,12 @@
# GetLibraryItemsEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `OLDEST_FIRST` | 0 |
| `NEWEST_FIRST` | 1 |

11
docs/models/operations/getlibraryitemsflattenseasons.md
View File

@@ -1,9 +1,12 @@
# GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `HIDE` | 0 |
| `SHOW` | 1 |

4
docs/models/operations/getlibraryitemsmetadata.md
View File

@@ -24,7 +24,9 @@
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [Optional[operations.GetLibraryItemsFlattenSeasons]](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `flatten_seasons` | [Optional[operations.GetLibraryItemsFlattenSeasons]](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episode_sort` | [Optional[operations.GetLibraryItemsEpisodeSort]](../../models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enable_credits_marker_generation` | [Optional[operations.GetLibraryItemsEnableCreditsMarkerGeneration]](../../models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `show_ordering` | [Optional[operations.GetLibraryItemsShowOrdering]](../../models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |

4
docs/models/operations/getrecentlyaddedmetadata.md
View File

@@ -24,7 +24,9 @@
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [Optional[operations.FlattenSeasons]](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `flatten_seasons` | [Optional[operations.FlattenSeasons]](../../models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episode_sort` | [Optional[operations.EpisodeSort]](../../models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enable_credits_marker_generation` | [Optional[operations.EnableCreditsMarkerGeneration]](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `show_ordering` | [Optional[operations.ShowOrdering]](../../models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |

11
docs/models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `DISABLED` | 0 |

12
docs/models/operations/getsearchalllibrariesepisodesort.md Normal file
View File

@@ -0,0 +1,12 @@
# GetSearchAllLibrariesEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Values
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `OLDEST_FIRST` | 0 |
| `NEWEST_FIRST` | 1 |

11
docs/models/operations/getsearchalllibrariesflattenseasons.md
View File

@@ -1,9 +1,12 @@
# GetSearchAllLibrariesFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Values
| Name | Value |
| ------- | ------- |
| `FALSE` | 0 |
| `TRUE` | 1 |
| Name | Value |
| ----------------- | ----------------- |
| `LIBRARY_DEFAULT` | -1 |
| `HIDE` | 0 |
| `SHOW` | 1 |

4
docs/models/operations/getsearchalllibrariesmetadata.md
View File

@@ -24,7 +24,9 @@
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flatten_seasons` | [Optional[operations.GetSearchAllLibrariesFlattenSeasons]](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `flatten_seasons` | [Optional[operations.GetSearchAllLibrariesFlattenSeasons]](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `episode_sort` | [Optional[operations.GetSearchAllLibrariesEpisodeSort]](../../models/operations/getsearchalllibrariesepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enable_credits_marker_generation` | [Optional[operations.GetSearchAllLibrariesEnableCreditsMarkerGeneration]](../../models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `show_ordering` | [Optional[operations.GetSearchAllLibrariesShowOrdering]](../../models/operations/getsearchalllibrariesshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>tvdbAiring = TheTVDB (Aired),<br/>tvdbDvd = TheTVDB (DVD),<br/>tvdbAbsolute = TheTVDB (Absolute)).<br/> | tvdbDvd |
| `thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |

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

@@ -10,4 +10,4 @@
| `timespan` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
| `at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1718387650 |
| `lan` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
| `bytes` | *Optional[int]* | :heavy_minus_sign: | N/A | 22 |
| `bytes_` | *Optional[int]* | :heavy_minus_sign: | N/A | 22 |

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

@@ -161,6 +161,7 @@ with PlexAPI() as plex_api:
"request_body": {
"login": "username@email.com",
"password": "password123",
"remember_me": False,
"verification_code": "123456",
},
})

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

@@ -221,12 +221,13 @@ Each type in the library comes with a set of filters and sorts, aiding in buildi
```python
from plex_api_client import PlexAPI
from plex_api_client.models import operations
with PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
) as plex_api:
res = plex_api.library.get_library_details(section_key=9518)
res = plex_api.library.get_library_details(section_key=9518, include_details=operations.IncludeDetails.ZERO)
assert res.object is not None

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

@@ -42,7 +42,7 @@ with PlexAPI(
"title": "<value>",
"type": operations.CreatePlaylistQueryParamType.PHOTO,
"smart": operations.Smart.ONE,
"uri": "https://inborn-brochure.biz",
"uri": "https://hoarse-testing.info/",
})
assert res.object is not None

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

@@ -236,6 +236,7 @@ with PlexAPI() as plex_api:
res = plex_api.plex.get_pin(request={
"client_id": "3381b62b-9ab7-4e37-827b-203e9809eb58",
"strong": False,
"client_name": "Plex for Roku",
"device_nickname": "Roku 3",
"client_version": "2.4.1",