ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.295.1

2025-12-09 20:57:44 +00:00 · 2024-05-23 15:57:59 +00:00
parent e11c88055c
commit a788b6dc7f
94 changed files with 2157 additions and 1240 deletions
--- a/docs/sdks/activities/README.md
+++ b/docs/sdks/activities/README.md
@@ -31,6 +31,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.activities.get_server_activities()

 if res.object is not None:
@@ -64,6 +65,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.activities.cancel_server_activities(activity_uuid='25b71ed5-0f9d-461c-baa7-d404e9e10d3e')

 if res is not None:
--- a/docs/sdks/authentication/README.md
+++ b/docs/sdks/authentication/README.md
@@ -27,6 +27,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.authentication.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)

 if res is not None:
@@ -69,6 +70,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.authentication.get_source_connection_information(source='server://client-identifier')

 if res is not None:
--- a/docs/sdks/butler/README.md
+++ b/docs/sdks/butler/README.md
@@ -28,6 +28,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.butler.get_butler_tasks()

 if res.object is not None:
@@ -66,6 +67,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.butler.start_all_tasks()

 if res is not None:
@@ -100,6 +102,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.butler.stop_all_tasks()

 if res is not None:
@@ -139,6 +142,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES)

 if res is not None:
@@ -180,6 +184,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE)

 if res is not None:
--- a/docs/sdks/hubs/README.md
+++ b/docs/sdks/hubs/README.md
@@ -26,6 +26,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.hubs.get_global_hubs(count=1262.49, only_transient=operations.OnlyTransient.ONE)

 if res.object is not None:
@@ -68,6 +69,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.hubs.get_library_hubs(section_id=6728.76, count=9010.22, only_transient=operations.QueryParamOnlyTransient.ZERO)

 if res.object is not None:
--- a/docs/sdks/library/README.md
+++ b/docs/sdks/library/README.md
@@ -13,6 +13,7 @@ API Calls interacting with Plex Media Server Libraries
 * [get_libraries](#get_libraries) - Get All Libraries
 * [get_library](#get_library) - Get Library Details
 * [delete_library](#delete_library) - Delete Library Section
+* [get_library_items](#get_library_items) - Get Library Items
 * [refresh_library](#refresh_library) - Refresh Library
 * [search_library](#search_library) - Search Library
 * [get_metadata](#get_metadata) - Get Items Metadata
@@ -33,6 +34,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_file_hash(url='file://C:\Image.png&type=13', type=4462.17)

 if res is not None:
@@ -74,6 +76,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_recently_added()

 if res.object is not None:
@@ -113,6 +116,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_libraries()

 if res.object is not None:
@@ -186,6 +190,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ZERO)

 if res.object is not None:
@@ -226,6 +231,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.delete_library(section_id=1000)

 if res is not None:
@@ -251,6 +257,68 @@ if res is not None:
 | errors.DeleteLibraryResponseBody | 401                              | application/json                 |
 | errors.SDKError                  | 4xx-5xx                          | */*                              |

+## get_library_items
+
+Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
+- `all`: All items in the section.
+- `unwatched`: Items that have not been played.
+- `newest`: Items that are recently released.
+- `recentlyAdded`: Items that are recently added to the library.
+- `recentlyViewed`: Items that were recently viewed.
+- `onDeck`: Items to continue watching.
+- `collection`: Items categorized by collection.
+- `edition`: Items categorized by edition.
+- `genre`: Items categorized by genre.
+- `year`: Items categorized by year of release.
+- `decade`: Items categorized by decade.
+- `director`: Items categorized by director.
+- `actor`: Items categorized by starring actor.
+- `country`: Items categorized by country of origin.
+- `contentRating`: Items categorized by content rating.
+- `rating`: Items categorized by rating.
+- `resolution`: Items categorized by resolution.
+- `firstCharacter`: Items categorized by the first letter.
+- `folder`: Items categorized by folder.
+
+
+### Example Usage
+
+```python
+import plex_api
+from plex_api.models import operations
+
+s = plex_api.PlexAPI(
+    access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='Postman',
+)
+
+
+res = s.library.get_library_items(section_id=1, tag=operations.Tag.GENRE)
+
+if res.object is not None:
+    # handle response
+    pass
+
+```
+
+### Parameters
+
+| Parameter                                             | Type                                                  | Required                                              | Description                                           | Example                                               |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `section_id`                                          | *int*                                                 | :heavy_check_mark:                                    | the Id of the library to query                        | 1                                                     |
+| `tag`                                                 | [operations.Tag](../../models/operations/tag.md)      | :heavy_check_mark:                                    | A key representing a specific tag within the section. |                                                       |
+
+
+### Response
+
+**[operations.GetLibraryItemsResponse](../../models/operations/getlibraryitemsresponse.md)**
+### Errors
+
+| Error Object                       | Status Code                        | Content Type                       |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| errors.GetLibraryItemsResponseBody | 401                                | application/json                   |
+| errors.SDKError                    | 4xx-5xx                            | */*                                |
+
 ## refresh_library

 This endpoint Refreshes the library.
@@ -266,6 +334,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.refresh_library(section_id=934.16)

 if res is not None:
@@ -324,6 +393,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.search_library(section_id=933505, type=operations.Type.FOUR)

 if res.object is not None:
@@ -345,9 +415,10 @@ if res.object is not None:
 **[operations.SearchLibraryResponse](../../models/operations/searchlibraryresponse.md)**
 ### Errors

-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Object                     | Status Code                      | Content Type                     |
+| -------------------------------- | -------------------------------- | -------------------------------- |
+| errors.SearchLibraryResponseBody | 401                              | application/json                 |
+| errors.SDKError                  | 4xx-5xx                          | */*                              |

 ## get_metadata

@@ -364,6 +435,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_metadata(rating_key=8382.31)

 if res.object is not None:
@@ -404,6 +476,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_metadata_children(rating_key=1539.14)

 if res.object is not None:
@@ -444,6 +517,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.library.get_on_deck()

 if res.object is not None:
--- a/docs/sdks/log/README.md
+++ b/docs/sdks/log/README.md
@@ -28,6 +28,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.log.log_line(level=operations.Level.THREE, message='Test log message', source='Postman')

 if res is not None:
@@ -90,6 +91,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.log.log_multi_line(request='level=4&message=Test%20message%201&source=postman
 level=3&message=Test%20message%202&source=postman
 level=1&message=Test%20message%203&source=postman')
@@ -132,6 +134,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.log.enable_paper_trail()

 if res is not None:
--- a/docs/sdks/media/README.md
+++ b/docs/sdks/media/README.md
@@ -26,6 +26,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.media.mark_played(key=59398)

 if res is not None:
@@ -65,6 +66,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.media.mark_unplayed(key=59398)

 if res is not None:
@@ -105,6 +107,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.media.update_play_progress(key='<value>', time=90000, state='played')

 if res is not None:
--- a/docs/sdks/playlists/README.md
+++ b/docs/sdks/playlists/README.md
@@ -39,6 +39,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.create_playlist(request=operations.CreatePlaylistRequest(
    title='<value>',
    type=operations.QueryParamType.PHOTO,
@@ -84,6 +85,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.get_playlists(playlist_type=operations.PlaylistType.AUDIO, smart=operations.QueryParamSmart.ZERO)

 if res.object is not None:
@@ -126,6 +128,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.get_playlist(playlist_id=4109.48)

 if res.object is not None:
@@ -166,6 +169,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.delete_playlist(playlist_id=216.22)

 if res is not None:
@@ -206,6 +210,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.update_playlist(playlist_id=3915, title='<value>', summary='<value>')

 if res is not None:
@@ -251,6 +256,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.get_playlist_contents(playlist_id=5004.46, type=9403.59)

 if res.object is not None:
@@ -292,6 +298,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.clear_playlist_contents(playlist_id=1893.18)

 if res is not None:
@@ -333,6 +340,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123)

 if res.object is not None:
@@ -376,6 +384,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.playlists.upload_playlist(path='/home/barkley/playlist.m3u', force=operations.Force.ZERO)

 if res is not None:
--- a/docs/sdks/plex/README.md
+++ b/docs/sdks/plex/README.md
@@ -24,6 +24,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman')

 if res.object is not None:
@@ -64,6 +65,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='Postman')

 if res is not None:
--- a/docs/sdks/search/README.md
+++ b/docs/sdks/search/README.md
@@ -38,6 +38,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.search.perform_search(query='dylan', section_id=1516.53, limit=5)

 if res is not None:
@@ -83,6 +84,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.search.perform_voice_search(query='dead+poop', section_id=4094.8, limit=5)

 if res is not None:
@@ -124,6 +126,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.search.get_search_results(query='110')

 if res.object is not None:
--- a/docs/sdks/server/README.md
+++ b/docs/sdks/server/README.md
@@ -31,6 +31,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_server_capabilities()

 if res.object is not None:
@@ -64,6 +65,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_server_preferences()

 if res.object is not None:
@@ -97,6 +99,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_available_clients()

 if res.object is not None:
@@ -130,6 +133,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_devices()

 if res.object is not None:
@@ -163,6 +167,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_server_identity()

 if res.object is not None:
@@ -196,6 +201,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_my_plex_account()

 if res.object is not None:
@@ -231,6 +237,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_resized_photo(request=operations.GetResizedPhotoRequest(
    width=110,
    height=165,
@@ -278,6 +285,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.server.get_server_list()

 if res.object is not None:
--- a/docs/sdks/sessions/README.md
+++ b/docs/sdks/sessions/README.md
@@ -27,6 +27,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.sessions.get_sessions()

 if res.object is not None:
@@ -60,6 +61,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.sessions.get_session_history()

 if res.object is not None:
@@ -93,6 +95,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.sessions.get_transcode_sessions()

 if res.object is not None:
@@ -126,6 +129,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.sessions.stop_transcode_session(session_key='zz7llzqlx8w9vnrsbnwhbmep')

 if res is not None:
--- a/docs/sdks/statistics/README.md
+++ b/docs/sdks/statistics/README.md
@@ -24,6 +24,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.statistics.get_statistics(timespan=4)

 if res.object is not None:
--- a/docs/sdks/updater/README.md
+++ b/docs/sdks/updater/README.md
@@ -27,6 +27,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.updater.get_update_status()

 if res.object is not None:
@@ -61,6 +62,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.updater.check_for_updates(download=operations.Download.ONE)

 if res is not None:
@@ -102,6 +104,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)

 if res is not None:
--- a/docs/sdks/video/README.md
+++ b/docs/sdks/video/README.md
@@ -26,6 +26,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.video.get_timeline(request=operations.GetTimelineRequest(
    rating_key=23409,
    key='/library/metadata/23409',
@@ -77,6 +78,7 @@ s = plex_api.PlexAPI(
    x_plex_client_identifier='Postman',
 )

+
 res = s.video.start_universal_transcode(request=operations.StartUniversalTranscodeRequest(
    has_mde=1,
    path='/library/metadata/23409',