From e0440840152a076655c8fea95800022b1505f99b Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 23 Jan 2024 00:32:38 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0 --- .speakeasy/gen.lock | 534 +++++++++++++----- RELEASES.md | 8 +- .../hubs/get_global_hubs/_response.mdx | 11 +- .../resources/hubs/get_global_hubs/_usage.mdx | 13 +- .../hubs/get_library_hubs/_response.mdx | 11 +- .../hubs/get_library_hubs/_usage.mdx | 16 +- .../_authentication.mdx | 9 - .../get_common_library_items/_header.mdx | 8 - .../get_common_library_items/_parameters.mdx | 12 - .../get_common_library_items/_response.mdx | 30 - .../get_common_library_items/_usage.mdx | 21 - .../get_common_library_items.mdx | 12 - .../_authentication.mdx | 9 - .../get_latest_library_items/_header.mdx | 8 - .../get_latest_library_items/_parameters.mdx | 12 - .../get_latest_library_items/_response.mdx | 26 - .../get_latest_library_items/_usage.mdx | 21 - .../get_latest_library_items.mdx | 12 - .../resources/library/get_library/_header.mdx | 56 +- .../library/get_library/_response.mdx | 11 +- .../resources/library/get_library/_usage.mdx | 24 +- .../library/get_library_items/_header.mdx | 24 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_response.mdx | 16 +- .../library/get_library_items/_usage.mdx | 26 +- .../library/get_metadata/_response.mdx | 11 +- .../resources/library/get_metadata/_usage.mdx | 20 +- .../get_metadata_children/_response.mdx | 11 +- .../library/get_metadata_children/_usage.mdx | 34 +- .../curl/resources/library/library.mdx | 10 - .../library/refresh_library/_usage.mdx | 2 +- .../resources/log/log_line/_parameters.mdx | 6 +- .../curl/resources/log/log_line/_usage.mdx | 2 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 7 + .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_response.mdx | 11 +- .../add_playlist_contents/_usage.mdx | 15 +- .../clear_playlist_contents/_usage.mdx | 2 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_parameters.mdx | 2 +- .../playlists/create_playlist/_response.mdx | 11 +- .../playlists/create_playlist/_usage.mdx | 13 +- .../playlists/delete_playlist/_usage.mdx | 2 +- .../playlists/get_playlist/_response.mdx | 11 +- .../playlists/get_playlist/_usage.mdx | 13 +- .../get_playlist_contents/_response.mdx | 11 +- .../get_playlist_contents/_usage.mdx | 20 +- .../playlists/get_playlists/_header.mdx | 2 +- .../playlists/get_playlists/_response.mdx | 11 +- .../playlists/get_playlists/_usage.mdx | 13 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 2 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../get_available_clients/_response.mdx | 11 +- .../server/get_available_clients/_usage.mdx | 40 +- .../get_server_preferences/_response.mdx | 11 +- .../server/get_server_preferences/_usage.mdx | 11 +- .../get_session_history/_response.mdx | 11 +- .../sessions/get_session_history/_usage.mdx | 11 +- .../sessions/get_sessions/_response.mdx | 11 +- .../sessions/get_sessions/_usage.mdx | 11 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../stop_transcode_session/_response.mdx | 2 +- .../updater/get_update_status/_response.mdx | 11 +- .../updater/get_update_status/_usage.mdx | 15 +- .../resources/video/get_timeline/_usage.mdx | 2 +- .../start_universal_transcode/_usage.mdx | 2 +- .../resources/hubs/get_global_hubs/_usage.mdx | 16 +- .../hubs/get_library_hubs/_usage.mdx | 19 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 16 - .../get_common_library_items/_response.mdx | 16 - .../get_common_library_items/_usage.mdx | 50 -- .../get_common_library_items.mdx | 12 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 16 - .../get_latest_library_items/_response.mdx | 16 - .../get_latest_library_items/_usage.mdx | 50 -- .../get_latest_library_items.mdx | 12 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 27 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_usage.mdx | 36 +- .../resources/library/get_metadata/_usage.mdx | 23 +- .../library/get_metadata_children/_usage.mdx | 37 +- .../go/resources/library/library.mdx | 10 - .../go/resources/log/log_line/_parameters.mdx | 6 +- .../go/resources/log/log_line/_usage.mdx | 6 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 4 + .../resources/log/log_multi_line/_usage.mdx | 4 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_usage.mdx | 20 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 19 +- .../playlists/get_playlist/_usage.mdx | 14 +- .../get_playlist_contents/_usage.mdx | 21 +- .../playlists/get_playlists/_usage.mdx | 14 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 6 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 42 +- .../server/get_server_preferences/_usage.mdx | 14 +- .../sessions/get_session_history/_usage.mdx | 14 +- .../sessions/get_sessions/_usage.mdx | 14 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 18 +- .../resources/hubs/get_global_hubs/_usage.mdx | 15 +- .../hubs/get_library_hubs/_usage.mdx | 18 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 12 - .../get_common_library_items/_response.mdx | 13 - .../get_common_library_items/_usage.mdx | 31 - .../get_common_library_items.mdx | 12 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 12 - .../get_latest_library_items/_response.mdx | 13 - .../get_latest_library_items/_usage.mdx | 31 - .../get_latest_library_items.mdx | 12 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 26 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_usage.mdx | 28 +- .../resources/library/get_metadata/_usage.mdx | 22 +- .../library/get_metadata_children/_usage.mdx | 36 +- .../python/resources/library/library.mdx | 10 - .../resources/log/log_line/_parameters.mdx | 6 +- .../python/resources/log/log_line/_usage.mdx | 2 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 2 + .../resources/log/log_multi_line/_usage.mdx | 5 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_usage.mdx | 17 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 18 +- .../playlists/get_playlist/_usage.mdx | 13 +- .../get_playlist_contents/_usage.mdx | 20 +- .../playlists/get_playlists/_usage.mdx | 13 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 2 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 42 +- .../server/get_server_preferences/_usage.mdx | 13 +- .../sessions/get_session_history/_usage.mdx | 13 +- .../sessions/get_sessions/_usage.mdx | 13 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 17 +- .../resources/hubs/get_global_hubs/_usage.mdx | 13 +- .../hubs/get_library_hubs/_usage.mdx | 16 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 20 - .../get_common_library_items/_response.mdx | 13 - .../get_common_library_items/_usage.mdx | 36 -- .../get_common_library_items.mdx | 12 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 20 - .../get_latest_library_items/_response.mdx | 13 - .../get_latest_library_items/_usage.mdx | 36 -- .../get_latest_library_items.mdx | 12 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 24 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 14 +- .../library/get_library_items/_usage.mdx | 32 +- .../resources/library/get_metadata/_usage.mdx | 20 +- .../library/get_metadata_children/_usage.mdx | 34 +- .../typescript/resources/library/library.mdx | 10 - .../resources/log/log_line/_parameters.mdx | 2 +- .../resources/log/log_line/_usage.mdx | 6 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 4 + .../resources/log/log_multi_line/_usage.mdx | 4 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 2 +- .../add_playlist_contents/_usage.mdx | 15 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 16 +- .../playlists/get_playlist/_usage.mdx | 11 +- .../get_playlist_contents/_usage.mdx | 18 +- .../playlists/get_playlists/_usage.mdx | 11 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 4 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 40 +- .../server/get_server_preferences/_usage.mdx | 11 +- .../sessions/get_session_history/_usage.mdx | 11 +- .../sessions/get_sessions/_usage.mdx | 11 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 15 +- .../python.mdx | 16 - .../typescript.mdx | 16 - .../python.mdx | 14 - .../typescript.mdx | 14 - .../python.mdx | 16 - .../typescript.mdx | 16 - .../python.mdx | 14 - .../typescript.mdx | 14 - .../get_library_items_errors/python.mdx | 16 - .../get_library_items_errors/typescript.mdx | 16 - .../python.mdx | 14 - .../typescript.mdx | 14 - .../go.mdx | 27 + .../python.mdx | 27 + .../typescript.mdx | 27 + .../add_playlist_contents_metadata/go.mdx | 66 +++ .../add_playlist_contents_metadata/python.mdx | 66 +++ .../typescript.mdx | 66 +++ .../add_playlist_contents_request/go.mdx | 4 +- .../add_playlist_contents_request/python.mdx | 4 +- .../typescript.mdx | 4 +- .../add_playlist_contents_response/go.mdx | 10 + .../add_playlist_contents_response/python.mdx | 10 + .../typescript.mdx | 10 + .../go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../create_playlist_media_container/go.mdx | 17 + .../python.mdx | 17 + .../typescript.mdx | 17 + .../create_playlist_metadata/go.mdx | 81 +++ .../create_playlist_metadata/python.mdx | 81 +++ .../create_playlist_metadata/typescript.mdx | 81 +++ .../operations/create_playlist_request/go.mdx | 2 +- .../create_playlist_request/python.mdx | 2 +- .../create_playlist_request/typescript.mdx | 2 +- .../create_playlist_response/go.mdx | 10 + .../create_playlist_response/python.mdx | 10 + .../create_playlist_response/typescript.mdx | 10 + .../create_playlist_response_body/go.mdx | 10 + .../create_playlist_response_body/python.mdx | 10 + .../typescript.mdx | 10 + content/types/models/operations/field/go.mdx | 21 + .../types/models/operations/field/python.mdx | 21 + .../models/operations/field/typescript.mdx | 21 + .../types/models/operations/field_type/go.mdx | 17 + .../models/operations/field_type/python.mdx | 17 + .../operations/field_type/typescript.mdx | 17 + content/types/models/operations/filter/go.mdx | 26 + .../types/models/operations/filter/python.mdx | 26 + .../models/operations/filter/typescript.mdx | 26 + .../get_available_clients_response/go.mdx | 4 +- .../get_available_clients_response/python.mdx | 4 +- .../typescript.mdx | 4 +- .../go.mdx | 0 .../python.mdx | 0 .../typescript.mdx | 0 .../get_common_library_items_request/go.mdx | 13 - .../python.mdx | 13 - .../typescript.mdx | 13 - .../get_common_library_items_response/go.mdx | 13 - .../python.mdx | 13 - .../typescript.mdx | 13 - .../get_global_hubs_media_container/go.mdx | 27 + .../python.mdx | 27 + .../typescript.mdx | 27 + .../get_global_hubs_metadata/go.mdx | 84 +++ .../get_global_hubs_metadata/python.mdx | 84 +++ .../get_global_hubs_metadata/typescript.mdx | 84 +++ .../get_global_hubs_response/go.mdx | 10 + .../get_global_hubs_response/python.mdx | 10 + .../get_global_hubs_response/typescript.mdx | 10 + .../get_global_hubs_response_body/go.mdx | 10 + .../get_global_hubs_response_body/python.mdx | 10 + .../typescript.mdx | 10 + .../get_latest_library_items_request/go.mdx | 13 - .../python.mdx | 13 - .../typescript.mdx | 13 - .../get_latest_library_items_response/go.mdx | 13 - .../python.mdx | 13 - .../typescript.mdx | 13 - .../operations/get_library_directory/go.mdx | 26 + .../get_library_directory/python.mdx | 26 + .../get_library_directory/typescript.mdx | 26 + .../get_library_hubs_country/go.mdx | 6 + .../get_library_hubs_country/python.mdx | 6 + .../get_library_hubs_country/typescript.mdx | 6 + .../get_library_hubs_director/go.mdx | 6 + .../get_library_hubs_director/python.mdx | 6 + .../get_library_hubs_director/typescript.mdx | 6 + .../operations/get_library_hubs_genre/go.mdx | 6 + .../get_library_hubs_genre/python.mdx | 6 + .../get_library_hubs_genre/typescript.mdx | 6 + .../operations/get_library_hubs_hub/go.mdx | 67 +++ .../get_library_hubs_hub/python.mdx | 67 +++ .../get_library_hubs_hub/typescript.mdx | 67 +++ .../operations/get_library_hubs_media/go.mdx | 92 +++ .../get_library_hubs_media/python.mdx | 92 +++ .../get_library_hubs_media/typescript.mdx | 92 +++ .../get_library_hubs_media_container/go.mdx | 42 ++ .../python.mdx | 42 ++ .../typescript.mdx | 42 ++ .../get_library_hubs_metadata/go.mdx | 192 +++++++ .../get_library_hubs_metadata/python.mdx | 192 +++++++ .../get_library_hubs_metadata/typescript.mdx | 192 +++++++ .../operations/get_library_hubs_part/go.mdx | 51 ++ .../get_library_hubs_part/python.mdx | 51 ++ .../get_library_hubs_part/typescript.mdx | 51 ++ .../get_library_hubs_response/go.mdx | 10 + .../get_library_hubs_response/python.mdx | 10 + .../get_library_hubs_response/typescript.mdx | 10 + .../get_library_hubs_response_body/go.mdx | 10 + .../get_library_hubs_response_body/python.mdx | 10 + .../typescript.mdx | 10 + .../operations/get_library_hubs_role/go.mdx | 6 + .../get_library_hubs_role/python.mdx | 6 + .../get_library_hubs_role/typescript.mdx | 6 + .../operations/get_library_hubs_writer/go.mdx | 6 + .../get_library_hubs_writer/python.mdx | 6 + .../get_library_hubs_writer/typescript.mdx | 6 + .../get_library_items_country/go.mdx | 6 + .../get_library_items_country/python.mdx | 6 + .../get_library_items_country/typescript.mdx | 6 + .../get_library_items_director/go.mdx | 6 + .../get_library_items_director/python.mdx | 6 + .../get_library_items_director/typescript.mdx | 6 + .../operations/get_library_items_genre/go.mdx | 6 + .../get_library_items_genre/python.mdx | 6 + .../get_library_items_genre/typescript.mdx | 6 + .../operations/get_library_items_media/go.mdx | 77 +++ .../get_library_items_media/python.mdx | 77 +++ .../get_library_items_media/typescript.mdx | 77 +++ .../get_library_items_media_container/go.mdx | 82 +++ .../python.mdx | 82 +++ .../typescript.mdx | 82 +++ .../get_library_items_metadata/go.mdx | 192 +++++++ .../get_library_items_metadata/python.mdx | 192 +++++++ .../get_library_items_metadata/typescript.mdx | 192 +++++++ .../operations/get_library_items_part/go.mdx | 36 ++ .../get_library_items_part/python.mdx | 36 ++ .../get_library_items_part/typescript.mdx | 36 ++ .../get_library_items_request/go.mdx | 14 +- .../get_library_items_request/python.mdx | 14 +- .../get_library_items_request/typescript.mdx | 12 +- .../get_library_items_response/go.mdx | 10 + .../get_library_items_response/python.mdx | 10 + .../get_library_items_response/typescript.mdx | 10 + .../get_library_items_response_body/go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../operations/get_library_items_role/go.mdx | 6 + .../get_library_items_role/python.mdx | 6 + .../get_library_items_role/typescript.mdx | 6 + .../get_library_items_writer/go.mdx | 6 + .../get_library_items_writer/python.mdx | 6 + .../get_library_items_writer/typescript.mdx | 6 + .../get_library_media_container/go.mdx | 88 +++ .../get_library_media_container/python.mdx | 88 +++ .../typescript.mdx | 88 +++ .../operations/get_library_response/go.mdx | 10 + .../get_library_response/python.mdx | 10 + .../get_library_response/typescript.mdx | 10 + .../get_library_response_body/go.mdx | 10 + .../get_library_response_body/python.mdx | 10 + .../get_library_response_body/typescript.mdx | 10 + .../models/operations/get_library_type/go.mdx | 48 ++ .../operations/get_library_type/python.mdx | 48 ++ .../get_library_type/typescript.mdx | 48 ++ .../get_metadata_children_directory/go.mdx | 26 + .../python.mdx | 26 + .../typescript.mdx | 26 + .../go.mdx | 125 ++++ .../python.mdx | 125 ++++ .../typescript.mdx | 125 ++++ .../get_metadata_children_metadata/go.mdx | 136 +++++ .../get_metadata_children_metadata/python.mdx | 136 +++++ .../typescript.mdx | 136 +++++ .../get_metadata_children_response/go.mdx | 10 + .../get_metadata_children_response/python.mdx | 10 + .../typescript.mdx | 10 + .../go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../operations/get_metadata_country/go.mdx | 16 + .../get_metadata_country/python.mdx | 16 + .../get_metadata_country/typescript.mdx | 16 + .../operations/get_metadata_director/go.mdx | 26 + .../get_metadata_director/python.mdx | 26 + .../get_metadata_director/typescript.mdx | 26 + .../operations/get_metadata_genre/go.mdx | 16 + .../operations/get_metadata_genre/python.mdx | 16 + .../get_metadata_genre/typescript.mdx | 16 + .../operations/get_metadata_media/go.mdx | 92 +++ .../operations/get_metadata_media/python.mdx | 92 +++ .../get_metadata_media/typescript.mdx | 92 +++ .../get_metadata_media_container/go.mdx | 52 ++ .../get_metadata_media_container/python.mdx | 52 ++ .../typescript.mdx | 52 ++ .../operations/get_metadata_metadata/go.mdx | 196 +++++++ .../get_metadata_metadata/python.mdx | 196 +++++++ .../get_metadata_metadata/typescript.mdx | 196 +++++++ .../operations/get_metadata_part/go.mdx | 62 ++ .../operations/get_metadata_part/python.mdx | 62 ++ .../get_metadata_part/typescript.mdx | 62 ++ .../operations/get_metadata_response/go.mdx | 10 + .../get_metadata_response/python.mdx | 10 + .../get_metadata_response/typescript.mdx | 10 + .../get_metadata_response_body/go.mdx | 10 + .../get_metadata_response_body/python.mdx | 10 + .../get_metadata_response_body/typescript.mdx | 10 + .../operations/get_metadata_role/go.mdx | 31 + .../operations/get_metadata_role/python.mdx | 31 + .../get_metadata_role/typescript.mdx | 31 + .../operations/get_metadata_writer/go.mdx | 26 + .../operations/get_metadata_writer/python.mdx | 26 + .../get_metadata_writer/typescript.mdx | 26 + .../operations/get_on_deck_guids/go.mdx | 6 + .../operations/get_on_deck_guids/python.mdx | 6 + .../get_on_deck_guids/typescript.mdx | 6 + .../operations/get_on_deck_metadata/go.mdx | 4 +- .../get_on_deck_metadata/python.mdx | 4 +- .../get_on_deck_metadata/typescript.mdx | 4 +- .../models/operations/get_on_deck_part/go.mdx | 4 +- .../operations/get_on_deck_part/python.mdx | 4 +- .../get_on_deck_part/typescript.mdx | 4 +- .../operations/get_on_deck_stream/go.mdx | 114 ++++ .../operations/get_on_deck_stream/python.mdx | 114 ++++ .../get_on_deck_stream/typescript.mdx | 114 ++++ .../get_playlist_contents_country/go.mdx | 6 + .../get_playlist_contents_country/python.mdx | 6 + .../typescript.mdx | 6 + .../get_playlist_contents_director/go.mdx | 6 + .../get_playlist_contents_director/python.mdx | 6 + .../typescript.mdx | 6 + .../get_playlist_contents_genre/go.mdx | 6 + .../get_playlist_contents_genre/python.mdx | 6 + .../typescript.mdx | 6 + .../get_playlist_contents_media/go.mdx | 92 +++ .../get_playlist_contents_media/python.mdx | 92 +++ .../typescript.mdx | 92 +++ .../go.mdx | 52 ++ .../python.mdx | 52 ++ .../typescript.mdx | 52 ++ .../get_playlist_contents_metadata/go.mdx | 182 ++++++ .../get_playlist_contents_metadata/python.mdx | 182 ++++++ .../typescript.mdx | 182 ++++++ .../get_playlist_contents_part/go.mdx | 51 ++ .../get_playlist_contents_part/python.mdx | 51 ++ .../get_playlist_contents_part/typescript.mdx | 51 ++ .../get_playlist_contents_response/go.mdx | 10 + .../get_playlist_contents_response/python.mdx | 10 + .../typescript.mdx | 10 + .../go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../get_playlist_contents_role/go.mdx | 6 + .../get_playlist_contents_role/python.mdx | 6 + .../get_playlist_contents_role/typescript.mdx | 6 + .../get_playlist_contents_writer/go.mdx | 6 + .../get_playlist_contents_writer/python.mdx | 6 + .../typescript.mdx | 6 + .../get_playlist_media_container/go.mdx | 17 + .../get_playlist_media_container/python.mdx | 17 + .../typescript.mdx | 17 + .../operations/get_playlist_metadata/go.mdx | 74 +++ .../get_playlist_metadata/python.mdx | 74 +++ .../get_playlist_metadata/typescript.mdx | 74 +++ .../operations/get_playlist_response/go.mdx | 10 + .../get_playlist_response/python.mdx | 10 + .../get_playlist_response/typescript.mdx | 10 + .../get_playlist_response_body/go.mdx | 10 + .../get_playlist_response_body/python.mdx | 10 + .../get_playlist_response_body/typescript.mdx | 10 + .../get_playlists_media_container/go.mdx | 17 + .../get_playlists_media_container/python.mdx | 17 + .../typescript.mdx | 17 + .../operations/get_playlists_metadata/go.mdx | 81 +++ .../get_playlists_metadata/python.mdx | 81 +++ .../get_playlists_metadata/typescript.mdx | 81 +++ .../operations/get_playlists_response/go.mdx | 10 + .../get_playlists_response/python.mdx | 10 + .../get_playlists_response/typescript.mdx | 10 + .../get_playlists_response_body/go.mdx | 10 + .../get_playlists_response_body/python.mdx | 10 + .../typescript.mdx | 10 + .../get_server_identity_response/go.mdx | 2 +- .../get_server_identity_response/python.mdx | 2 +- .../typescript.mdx | 2 +- .../go.mdx | 17 + .../python.mdx | 17 + .../typescript.mdx | 11 + .../get_server_preferences_response/go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../go.mdx | 17 + .../python.mdx | 17 + .../typescript.mdx | 17 + .../get_session_history_metadata/go.mdx | 96 ++++ .../get_session_history_metadata/python.mdx | 96 ++++ .../typescript.mdx | 96 ++++ .../get_session_history_response/go.mdx | 10 + .../get_session_history_response/python.mdx | 10 + .../typescript.mdx | 10 + .../get_session_history_response_body/go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + .../operations/get_sessions_media/go.mdx | 47 ++ .../operations/get_sessions_media/python.mdx | 47 ++ .../get_sessions_media/typescript.mdx | 47 ++ .../get_sessions_media_container/go.mdx | 17 + .../get_sessions_media_container/python.mdx | 17 + .../typescript.mdx | 17 + .../operations/get_sessions_metadata/go.mdx | 195 +++++++ .../get_sessions_metadata/python.mdx | 195 +++++++ .../get_sessions_metadata/typescript.mdx | 195 +++++++ .../operations/get_sessions_part/go.mdx | 57 ++ .../operations/get_sessions_part/python.mdx | 57 ++ .../get_sessions_part/typescript.mdx | 57 ++ .../operations/get_sessions_response/go.mdx | 10 + .../get_sessions_response/python.mdx | 10 + .../get_sessions_response/typescript.mdx | 10 + .../get_sessions_response_body/go.mdx | 10 + .../get_sessions_response_body/python.mdx | 10 + .../get_sessions_response_body/typescript.mdx | 10 + .../operations/get_sessions_stream/go.mdx | 101 ++++ .../operations/get_sessions_stream/python.mdx | 101 ++++ .../get_sessions_stream/typescript.mdx | 101 ++++ .../go.mdx | 4 +- .../python.mdx | 4 +- .../typescript.mdx | 2 + .../get_update_status_media_container/go.mdx | 37 ++ .../python.mdx | 37 ++ .../typescript.mdx | 37 ++ .../get_update_status_response/go.mdx | 10 + .../get_update_status_response/python.mdx | 10 + .../get_update_status_response/typescript.mdx | 10 + .../get_update_status_response_body/go.mdx | 10 + .../python.mdx | 10 + .../typescript.mdx | 10 + content/types/models/operations/guids/go.mdx | 2 +- .../types/models/operations/guids/python.mdx | 2 +- .../models/operations/guids/typescript.mdx | 2 +- content/types/models/operations/hub/go.mdx | 62 ++ .../types/models/operations/hub/python.mdx | 62 ++ .../models/operations/hub/typescript.mdx | 62 ++ .../models/operations/log_line_request/go.mdx | 6 +- .../operations/log_line_request/python.mdx | 6 +- .../log_line_request/typescript.mdx | 6 +- content/types/models/operations/one/go.mdx | 44 ++ .../types/models/operations/one/python.mdx | 44 ++ .../models/operations/one/typescript.mdx | 44 ++ .../types/models/operations/operator/go.mdx | 11 + .../models/operations/operator/python.mdx | 11 + .../models/operations/operator/typescript.mdx | 11 + content/types/models/operations/player/go.mdx | 76 +++ .../types/models/operations/player/python.mdx | 76 +++ .../models/operations/player/typescript.mdx | 76 +++ .../types/models/operations/producer/go.mdx | 26 + .../models/operations/producer/python.mdx | 26 + .../models/operations/producer/typescript.mdx | 26 + .../types/models/operations/ratings/go.mdx | 16 + .../models/operations/ratings/python.mdx | 16 + .../models/operations/ratings/typescript.mdx | 16 + .../types/models/operations/release/go.mdx | 46 ++ .../models/operations/release/python.mdx | 46 ++ .../models/operations/release/typescript.mdx | 46 ++ .../types/models/operations/session/go.mdx | 16 + .../models/operations/session/python.mdx | 16 + .../models/operations/session/typescript.mdx | 16 + .../types/models/operations/setting/go.mdx | 2 + .../models/operations/setting/python.mdx | 2 + .../models/operations/setting/typescript.mdx | 2 + content/types/models/operations/sort/go.mdx | 31 + .../types/models/operations/sort/python.mdx | 31 + .../models/operations/sort/typescript.mdx | 31 + content/types/models/operations/stream/go.mdx | 197 ++++--- .../types/models/operations/stream/python.mdx | 197 ++++--- .../models/operations/stream/typescript.mdx | 189 ++++--- content/types/models/operations/tag/go.mdx | 25 + .../types/models/operations/tag/python.mdx | 25 + .../models/operations/tag/typescript.mdx | 25 + .../operations/transcode_session/go.mdx | 42 +- .../operations/transcode_session/python.mdx | 42 +- .../transcode_session/typescript.mdx | 36 +- content/types/models/operations/two/go.mdx | 49 ++ .../types/models/operations/two/python.mdx | 49 ++ .../models/operations/two/typescript.mdx | 49 ++ .../operations/update_playlist_request/go.mdx | 8 + .../update_playlist_request/python.mdx | 8 + .../update_playlist_request/typescript.mdx | 8 + .../operations/upload_playlist_request/go.mdx | 6 +- .../upload_playlist_request/python.mdx | 6 +- .../upload_playlist_request/typescript.mdx | 6 +- content/types/models/operations/user/go.mdx | 16 + .../types/models/operations/user/python.mdx | 16 + .../models/operations/user/typescript.mdx | 16 + .../get_common_library_items_errors/go.mdx | 16 - .../go.mdx | 14 - .../get_latest_library_items_errors/go.mdx | 16 - .../go.mdx | 14 - .../sdkerrors/get_library_items_errors/go.mdx | 16 - .../get_library_items_response_body/go.mdx | 14 - .../curl.mdx | 21 + .../add_playlist_contents_metadata/curl.mdx | 66 +++ .../curl.mdx | 0 .../add_playlist_contents_request/curl.mdx | 4 +- .../add_playlist_contents_response/curl.mdx | 11 +- .../curl.mdx | 8 +- .../create_playlist_media_container/curl.mdx | 11 + .../create_playlist_metadata/curl.mdx | 81 +++ .../curl.mdx | 0 .../create_playlist_request/curl.mdx | 2 +- .../create_playlist_response/curl.mdx | 11 +- .../create_playlist_response_body/curl.mdx | 8 +- content/types/operations/field/curl.mdx | 21 + content/types/operations/field_type/curl.mdx | 11 + content/types/operations/filter/curl.mdx | 26 + .../get_available_clients_response/curl.mdx | 13 +- .../curl.mdx | 8 +- .../curl.mdx | 4 + .../get_common_library_items_errors/curl.mdx | 16 - .../get_common_library_items_request/curl.mdx | 13 - .../curl.mdx | 23 - .../curl.mdx | 4 + .../get_global_hubs_media_container/curl.mdx | 21 + .../get_global_hubs_metadata/curl.mdx | 84 +++ .../get_global_hubs_response/curl.mdx | 11 +- .../get_global_hubs_response_body/curl.mdx | 8 +- .../get_latest_library_items_errors/curl.mdx | 16 - .../get_latest_library_items_request/curl.mdx | 13 - .../curl.mdx | 23 - .../operations/get_library_directory/curl.mdx | 26 + .../get_library_hubs_country/curl.mdx | 6 + .../get_library_hubs_director/curl.mdx | 6 + .../get_library_hubs_genre/curl.mdx | 6 + .../operations/get_library_hubs_hub/curl.mdx | 61 ++ .../curl.mdx | 4 + .../get_library_hubs_media/curl.mdx | 86 +++ .../get_library_hubs_media_container/curl.mdx | 36 ++ .../get_library_hubs_metadata/curl.mdx | 171 ++++++ .../operations/get_library_hubs_part/curl.mdx | 51 ++ .../get_library_hubs_response/curl.mdx | 11 +- .../get_library_hubs_response_body/curl.mdx | 8 +- .../operations/get_library_hubs_role/curl.mdx | 6 + .../get_library_hubs_writer/curl.mdx | 6 + .../get_library_items_country/curl.mdx | 6 + .../get_library_items_director/curl.mdx | 6 + .../get_library_items_errors/curl.mdx | 16 - .../get_library_items_genre/curl.mdx | 6 + .../get_library_items_media/curl.mdx | 71 +++ .../curl.mdx | 76 +++ .../get_library_items_metadata/curl.mdx | 171 ++++++ .../get_library_items_part/curl.mdx | 36 ++ .../get_library_items_request/curl.mdx | 14 +- .../get_library_items_response/curl.mdx | 2 +- .../get_library_items_response_body/curl.mdx | 8 +- .../get_library_items_role/curl.mdx | 6 + .../get_library_items_writer/curl.mdx | 6 + .../curl.mdx | 4 + .../get_library_media_container/curl.mdx | 76 +++ .../operations/get_library_response/curl.mdx | 11 +- .../get_library_response_body/curl.mdx | 8 +- .../operations/get_library_type/curl.mdx | 36 ++ .../get_metadata_children_directory/curl.mdx | 26 + .../curl.mdx | 4 + .../curl.mdx | 116 ++++ .../get_metadata_children_metadata/curl.mdx | 136 +++++ .../get_metadata_children_response/curl.mdx | 11 +- .../curl.mdx | 8 +- .../operations/get_metadata_country/curl.mdx | 16 + .../operations/get_metadata_director/curl.mdx | 26 + .../operations/get_metadata_genre/curl.mdx | 16 + .../curl.mdx | 4 + .../operations/get_metadata_media/curl.mdx | 86 +++ .../get_metadata_media_container/curl.mdx | 46 ++ .../operations/get_metadata_metadata/curl.mdx | 166 ++++++ .../operations/get_metadata_part/curl.mdx | 56 ++ .../operations/get_metadata_response/curl.mdx | 11 +- .../get_metadata_response_body/curl.mdx | 8 +- .../operations/get_metadata_role/curl.mdx | 31 + .../operations/get_metadata_writer/curl.mdx | 26 + .../operations/get_on_deck_guids/curl.mdx | 6 + .../operations/get_on_deck_stream/curl.mdx | 114 ++++ .../get_playlist_contents_country/curl.mdx | 6 + .../get_playlist_contents_director/curl.mdx | 6 + .../get_playlist_contents_genre/curl.mdx | 6 + .../get_playlist_contents_media/curl.mdx | 86 +++ .../curl.mdx | 46 ++ .../get_playlist_contents_metadata/curl.mdx | 161 ++++++ .../get_playlist_contents_part/curl.mdx | 51 ++ .../curl.mdx | 4 + .../get_playlist_contents_response/curl.mdx | 11 +- .../curl.mdx | 8 +- .../get_playlist_contents_role/curl.mdx | 6 + .../get_playlist_contents_writer/curl.mdx | 6 + .../get_playlist_media_container/curl.mdx | 11 + .../operations/get_playlist_metadata/curl.mdx | 74 +++ .../curl.mdx | 4 + .../operations/get_playlist_response/curl.mdx | 11 +- .../get_playlist_response_body/curl.mdx | 8 +- .../get_playlists_media_container/curl.mdx | 11 + .../get_playlists_metadata/curl.mdx | 81 +++ .../curl.mdx | 4 + .../get_playlists_response/curl.mdx | 11 +- .../get_playlists_response_body/curl.mdx | 8 +- .../get_server_identity_response/curl.mdx | 2 +- .../curl.mdx | 11 + .../get_server_preferences_response/curl.mdx | 11 +- .../curl.mdx | 8 +- .../curl.mdx | 4 + .../curl.mdx | 11 + .../get_session_history_metadata/curl.mdx | 96 ++++ .../get_session_history_response/curl.mdx | 11 +- .../curl.mdx | 8 +- .../curl.mdx | 4 + .../operations/get_sessions_media/curl.mdx | 41 ++ .../get_sessions_media_container/curl.mdx | 11 + .../operations/get_sessions_metadata/curl.mdx | 192 +++++++ .../operations/get_sessions_part/curl.mdx | 51 ++ .../operations/get_sessions_response/curl.mdx | 11 +- .../get_sessions_response_body/curl.mdx | 8 +- .../curl.mdx | 4 + .../operations/get_sessions_stream/curl.mdx | 101 ++++ .../curl.mdx | 4 +- .../curl.mdx | 31 + .../get_update_status_response/curl.mdx | 11 +- .../get_update_status_response_body/curl.mdx | 8 +- .../curl.mdx | 4 + content/types/operations/guids/curl.mdx | 2 +- content/types/operations/hub/curl.mdx | 56 ++ .../operations/log_line_request/curl.mdx | 6 +- .../log_multi_line_request_body/curl.mdx | 1 + content/types/operations/one/curl.mdx | 44 ++ content/types/operations/operator/curl.mdx | 11 + content/types/operations/player/curl.mdx | 76 +++ content/types/operations/producer/curl.mdx | 26 + content/types/operations/ratings/curl.mdx | 16 + content/types/operations/release/curl.mdx | 46 ++ .../types/operations/response_body/curl.mdx | 10 - content/types/operations/session/curl.mdx | 16 + content/types/operations/setting/curl.mdx | 2 + content/types/operations/sort/curl.mdx | 31 + content/types/operations/stream/curl.mdx | 197 ++++--- content/types/operations/tag/curl.mdx | 4 + .../operations/transcode_session/curl.mdx | 42 +- content/types/operations/two/curl.mdx | 49 ++ .../update_playlist_request/curl.mdx | 8 + .../upload_playlist_request/curl.mdx | 6 +- content/types/operations/user/curl.mdx | 16 + gen.yaml | 2 +- package.json | 2 +- .../hubs/get_global_hubs/_response.mdx | 11 +- .../resources/hubs/get_global_hubs/_usage.mdx | 13 +- .../hubs/get_library_hubs/_response.mdx | 11 +- .../hubs/get_library_hubs/_usage.mdx | 16 +- .../_authentication.mdx | 9 - .../get_common_library_items/_header.mdx | 8 - .../get_common_library_items/_parameters.mdx | 12 - .../get_common_library_items/_response.mdx | 30 - .../get_common_library_items/_usage.mdx | 21 - .../get_common_library_items.mdx | 6 - .../get_common_library_items_content.mdx | 21 - .../_authentication.mdx | 9 - .../get_latest_library_items/_header.mdx | 8 - .../get_latest_library_items/_parameters.mdx | 12 - .../get_latest_library_items/_response.mdx | 26 - .../get_latest_library_items/_usage.mdx | 21 - .../get_latest_library_items.mdx | 6 - .../get_latest_library_items_content.mdx | 21 - .../resources/library/get_library/_header.mdx | 56 +- .../library/get_library/_response.mdx | 11 +- .../resources/library/get_library/_usage.mdx | 24 +- .../library/get_library_items/_header.mdx | 24 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_response.mdx | 16 +- .../library/get_library_items/_usage.mdx | 26 +- .../library/get_metadata/_response.mdx | 11 +- .../resources/library/get_metadata/_usage.mdx | 20 +- .../get_metadata_children/_response.mdx | 11 +- .../library/get_metadata_children/_usage.mdx | 34 +- .../resources/library/library_content.mdx | 10 - .../library/refresh_library/_usage.mdx | 2 +- .../resources/log/log_line/_parameters.mdx | 6 +- .../curl/resources/log/log_line/_usage.mdx | 2 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 7 + .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_response.mdx | 11 +- .../add_playlist_contents/_usage.mdx | 15 +- .../clear_playlist_contents/_usage.mdx | 2 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_parameters.mdx | 2 +- .../playlists/create_playlist/_response.mdx | 11 +- .../playlists/create_playlist/_usage.mdx | 13 +- .../playlists/delete_playlist/_usage.mdx | 2 +- .../playlists/get_playlist/_response.mdx | 11 +- .../playlists/get_playlist/_usage.mdx | 13 +- .../get_playlist_contents/_response.mdx | 11 +- .../get_playlist_contents/_usage.mdx | 20 +- .../playlists/get_playlists/_header.mdx | 2 +- .../playlists/get_playlists/_response.mdx | 11 +- .../playlists/get_playlists/_usage.mdx | 13 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 2 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../get_available_clients/_response.mdx | 11 +- .../server/get_available_clients/_usage.mdx | 40 +- .../get_server_preferences/_response.mdx | 11 +- .../server/get_server_preferences/_usage.mdx | 11 +- .../get_session_history/_response.mdx | 11 +- .../sessions/get_session_history/_usage.mdx | 11 +- .../sessions/get_sessions/_response.mdx | 11 +- .../sessions/get_sessions/_usage.mdx | 11 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../stop_transcode_session/_response.mdx | 2 +- .../updater/get_update_status/_response.mdx | 11 +- .../updater/get_update_status/_usage.mdx | 15 +- .../resources/video/get_timeline/_usage.mdx | 2 +- .../start_universal_transcode/_usage.mdx | 2 +- .../resources/hubs/get_global_hubs/_usage.mdx | 16 +- .../hubs/get_library_hubs/_usage.mdx | 19 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 16 - .../get_common_library_items/_response.mdx | 16 - .../get_common_library_items/_usage.mdx | 50 -- .../get_common_library_items.mdx | 6 - .../get_common_library_items_content.mdx | 21 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 16 - .../get_latest_library_items/_response.mdx | 16 - .../get_latest_library_items/_usage.mdx | 50 -- .../get_latest_library_items.mdx | 6 - .../get_latest_library_items_content.mdx | 21 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 27 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_usage.mdx | 36 +- .../resources/library/get_metadata/_usage.mdx | 23 +- .../library/get_metadata_children/_usage.mdx | 37 +- .../go/resources/library/library_content.mdx | 10 - .../go/resources/log/log_line/_parameters.mdx | 6 +- .../go/resources/log/log_line/_usage.mdx | 6 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 4 + .../resources/log/log_multi_line/_usage.mdx | 4 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_usage.mdx | 20 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 19 +- .../playlists/get_playlist/_usage.mdx | 14 +- .../get_playlist_contents/_usage.mdx | 21 +- .../playlists/get_playlists/_usage.mdx | 14 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 6 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 42 +- .../server/get_server_preferences/_usage.mdx | 14 +- .../sessions/get_session_history/_usage.mdx | 14 +- .../sessions/get_sessions/_usage.mdx | 14 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 18 +- .../resources/hubs/get_global_hubs/_usage.mdx | 15 +- .../hubs/get_library_hubs/_usage.mdx | 18 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 12 - .../get_common_library_items/_response.mdx | 13 - .../get_common_library_items/_usage.mdx | 31 - .../get_common_library_items.mdx | 6 - .../get_common_library_items_content.mdx | 21 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 12 - .../get_latest_library_items/_response.mdx | 13 - .../get_latest_library_items/_usage.mdx | 31 - .../get_latest_library_items.mdx | 6 - .../get_latest_library_items_content.mdx | 21 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 26 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 16 +- .../library/get_library_items/_usage.mdx | 28 +- .../resources/library/get_metadata/_usage.mdx | 22 +- .../library/get_metadata_children/_usage.mdx | 36 +- .../resources/library/library_content.mdx | 10 - .../resources/log/log_line/_parameters.mdx | 6 +- .../python/resources/log/log_line/_usage.mdx | 2 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 2 + .../resources/log/log_multi_line/_usage.mdx | 5 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 4 +- .../add_playlist_contents/_usage.mdx | 17 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 18 +- .../playlists/get_playlist/_usage.mdx | 13 +- .../get_playlist_contents/_usage.mdx | 20 +- .../playlists/get_playlists/_usage.mdx | 13 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 2 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 42 +- .../server/get_server_preferences/_usage.mdx | 13 +- .../sessions/get_session_history/_usage.mdx | 13 +- .../sessions/get_sessions/_usage.mdx | 13 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 17 +- .../resources/hubs/get_global_hubs/_usage.mdx | 13 +- .../hubs/get_library_hubs/_usage.mdx | 16 +- .../get_common_library_items/_header.mdx | 3 - .../get_common_library_items/_parameters.mdx | 20 - .../get_common_library_items/_response.mdx | 13 - .../get_common_library_items/_usage.mdx | 36 -- .../get_common_library_items.mdx | 6 - .../get_common_library_items_content.mdx | 21 - .../get_latest_library_items/_header.mdx | 3 - .../get_latest_library_items/_parameters.mdx | 20 - .../get_latest_library_items/_response.mdx | 13 - .../get_latest_library_items/_usage.mdx | 36 -- .../get_latest_library_items.mdx | 6 - .../get_latest_library_items_content.mdx | 21 - .../resources/library/get_library/_header.mdx | 56 +- .../resources/library/get_library/_usage.mdx | 24 +- .../library/get_library_items/_header.mdx | 22 +- .../library/get_library_items/_parameters.mdx | 14 +- .../library/get_library_items/_usage.mdx | 32 +- .../resources/library/get_metadata/_usage.mdx | 20 +- .../library/get_metadata_children/_usage.mdx | 34 +- .../resources/library/library_content.mdx | 10 - .../resources/log/log_line/_parameters.mdx | 2 +- .../resources/log/log_line/_usage.mdx | 6 +- .../resources/log/log_multi_line/_header.mdx | 22 +- .../log/log_multi_line/_parameters.mdx | 4 + .../resources/log/log_multi_line/_usage.mdx | 4 +- .../add_playlist_contents/_header.mdx | 2 +- .../add_playlist_contents/_parameters.mdx | 2 +- .../add_playlist_contents/_usage.mdx | 15 +- .../playlists/create_playlist/_header.mdx | 2 +- .../playlists/create_playlist/_usage.mdx | 16 +- .../playlists/get_playlist/_usage.mdx | 11 +- .../get_playlist_contents/_usage.mdx | 18 +- .../playlists/get_playlists/_usage.mdx | 11 +- .../playlists/update_playlist/_parameters.mdx | 8 + .../playlists/update_playlist/_usage.mdx | 4 +- .../playlists/upload_playlist/_parameters.mdx | 6 +- .../server/get_available_clients/_usage.mdx | 40 +- .../server/get_server_preferences/_usage.mdx | 11 +- .../sessions/get_session_history/_usage.mdx | 11 +- .../sessions/get_sessions/_usage.mdx | 11 +- .../get_transcode_sessions/_usage.mdx | 27 +- .../updater/get_update_status/_usage.mdx | 15 +- src/pages/curl/library/_meta.json | 6 +- src/pages/go/library/_meta.json | 6 +- src/pages/python/library/_meta.json | 6 +- src/pages/typescript/library/_meta.json | 6 +- 954 files changed, 20504 insertions(+), 4484 deletions(-) delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 content/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 content/types/models/errors/get_common_library_items_errors/python.mdx delete mode 100644 content/types/models/errors/get_common_library_items_errors/typescript.mdx delete mode 100644 content/types/models/errors/get_common_library_items_response_body/python.mdx delete mode 100644 content/types/models/errors/get_common_library_items_response_body/typescript.mdx delete mode 100644 content/types/models/errors/get_latest_library_items_errors/python.mdx delete mode 100644 content/types/models/errors/get_latest_library_items_errors/typescript.mdx delete mode 100644 content/types/models/errors/get_latest_library_items_response_body/python.mdx delete mode 100644 content/types/models/errors/get_latest_library_items_response_body/typescript.mdx delete mode 100644 content/types/models/errors/get_library_items_errors/python.mdx delete mode 100644 content/types/models/errors/get_library_items_errors/typescript.mdx delete mode 100644 content/types/models/errors/get_library_items_response_body/python.mdx delete mode 100644 content/types/models/errors/get_library_items_response_body/typescript.mdx create mode 100644 content/types/models/operations/add_playlist_contents_media_container/go.mdx create mode 100644 content/types/models/operations/add_playlist_contents_media_container/python.mdx create mode 100644 content/types/models/operations/add_playlist_contents_media_container/typescript.mdx create mode 100644 content/types/models/operations/add_playlist_contents_metadata/go.mdx create mode 100644 content/types/models/operations/add_playlist_contents_metadata/python.mdx create mode 100644 content/types/models/operations/add_playlist_contents_metadata/typescript.mdx create mode 100644 content/types/models/operations/add_playlist_contents_response_body/go.mdx create mode 100644 content/types/models/operations/add_playlist_contents_response_body/python.mdx create mode 100644 content/types/models/operations/add_playlist_contents_response_body/typescript.mdx create mode 100644 content/types/models/operations/create_playlist_media_container/go.mdx create mode 100644 content/types/models/operations/create_playlist_media_container/python.mdx create mode 100644 content/types/models/operations/create_playlist_media_container/typescript.mdx create mode 100644 content/types/models/operations/create_playlist_metadata/go.mdx create mode 100644 content/types/models/operations/create_playlist_metadata/python.mdx create mode 100644 content/types/models/operations/create_playlist_metadata/typescript.mdx create mode 100644 content/types/models/operations/create_playlist_response_body/go.mdx create mode 100644 content/types/models/operations/create_playlist_response_body/python.mdx create mode 100644 content/types/models/operations/create_playlist_response_body/typescript.mdx create mode 100644 content/types/models/operations/field/go.mdx create mode 100644 content/types/models/operations/field/python.mdx create mode 100644 content/types/models/operations/field/typescript.mdx create mode 100644 content/types/models/operations/field_type/go.mdx create mode 100644 content/types/models/operations/field_type/python.mdx create mode 100644 content/types/models/operations/field_type/typescript.mdx create mode 100644 content/types/models/operations/filter/go.mdx create mode 100644 content/types/models/operations/filter/python.mdx create mode 100644 content/types/models/operations/filter/typescript.mdx rename content/types/models/operations/{response_body => get_available_clients_response_body}/go.mdx (100%) rename content/types/models/operations/{response_body => get_available_clients_response_body}/python.mdx (100%) rename content/types/models/operations/{response_body => get_available_clients_response_body}/typescript.mdx (100%) delete mode 100644 content/types/models/operations/get_common_library_items_request/go.mdx delete mode 100644 content/types/models/operations/get_common_library_items_request/python.mdx delete mode 100644 content/types/models/operations/get_common_library_items_request/typescript.mdx delete mode 100644 content/types/models/operations/get_common_library_items_response/go.mdx delete mode 100644 content/types/models/operations/get_common_library_items_response/python.mdx delete mode 100644 content/types/models/operations/get_common_library_items_response/typescript.mdx create mode 100644 content/types/models/operations/get_global_hubs_media_container/go.mdx create mode 100644 content/types/models/operations/get_global_hubs_media_container/python.mdx create mode 100644 content/types/models/operations/get_global_hubs_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_global_hubs_metadata/go.mdx create mode 100644 content/types/models/operations/get_global_hubs_metadata/python.mdx create mode 100644 content/types/models/operations/get_global_hubs_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_global_hubs_response_body/go.mdx create mode 100644 content/types/models/operations/get_global_hubs_response_body/python.mdx create mode 100644 content/types/models/operations/get_global_hubs_response_body/typescript.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_request/go.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_request/python.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_request/typescript.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_response/go.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_response/python.mdx delete mode 100644 content/types/models/operations/get_latest_library_items_response/typescript.mdx create mode 100644 content/types/models/operations/get_library_directory/go.mdx create mode 100644 content/types/models/operations/get_library_directory/python.mdx create mode 100644 content/types/models/operations/get_library_directory/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_country/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_country/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_country/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_director/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_director/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_director/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_genre/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_genre/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_genre/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_hub/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_hub/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_hub/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_media/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_media/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_media/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_media_container/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_media_container/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_metadata/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_metadata/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_part/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_part/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_part/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_response_body/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_response_body/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_role/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_role/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_role/typescript.mdx create mode 100644 content/types/models/operations/get_library_hubs_writer/go.mdx create mode 100644 content/types/models/operations/get_library_hubs_writer/python.mdx create mode 100644 content/types/models/operations/get_library_hubs_writer/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_country/go.mdx create mode 100644 content/types/models/operations/get_library_items_country/python.mdx create mode 100644 content/types/models/operations/get_library_items_country/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_director/go.mdx create mode 100644 content/types/models/operations/get_library_items_director/python.mdx create mode 100644 content/types/models/operations/get_library_items_director/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_genre/go.mdx create mode 100644 content/types/models/operations/get_library_items_genre/python.mdx create mode 100644 content/types/models/operations/get_library_items_genre/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_media/go.mdx create mode 100644 content/types/models/operations/get_library_items_media/python.mdx create mode 100644 content/types/models/operations/get_library_items_media/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_media_container/go.mdx create mode 100644 content/types/models/operations/get_library_items_media_container/python.mdx create mode 100644 content/types/models/operations/get_library_items_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_metadata/go.mdx create mode 100644 content/types/models/operations/get_library_items_metadata/python.mdx create mode 100644 content/types/models/operations/get_library_items_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_part/go.mdx create mode 100644 content/types/models/operations/get_library_items_part/python.mdx create mode 100644 content/types/models/operations/get_library_items_part/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_response_body/go.mdx create mode 100644 content/types/models/operations/get_library_items_response_body/python.mdx create mode 100644 content/types/models/operations/get_library_items_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_role/go.mdx create mode 100644 content/types/models/operations/get_library_items_role/python.mdx create mode 100644 content/types/models/operations/get_library_items_role/typescript.mdx create mode 100644 content/types/models/operations/get_library_items_writer/go.mdx create mode 100644 content/types/models/operations/get_library_items_writer/python.mdx create mode 100644 content/types/models/operations/get_library_items_writer/typescript.mdx create mode 100644 content/types/models/operations/get_library_media_container/go.mdx create mode 100644 content/types/models/operations/get_library_media_container/python.mdx create mode 100644 content/types/models/operations/get_library_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_library_response_body/go.mdx create mode 100644 content/types/models/operations/get_library_response_body/python.mdx create mode 100644 content/types/models/operations/get_library_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_library_type/go.mdx create mode 100644 content/types/models/operations/get_library_type/python.mdx create mode 100644 content/types/models/operations/get_library_type/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_children_directory/go.mdx create mode 100644 content/types/models/operations/get_metadata_children_directory/python.mdx create mode 100644 content/types/models/operations/get_metadata_children_directory/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_children_media_container/go.mdx create mode 100644 content/types/models/operations/get_metadata_children_media_container/python.mdx create mode 100644 content/types/models/operations/get_metadata_children_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_children_metadata/go.mdx create mode 100644 content/types/models/operations/get_metadata_children_metadata/python.mdx create mode 100644 content/types/models/operations/get_metadata_children_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_children_response_body/go.mdx create mode 100644 content/types/models/operations/get_metadata_children_response_body/python.mdx create mode 100644 content/types/models/operations/get_metadata_children_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_country/go.mdx create mode 100644 content/types/models/operations/get_metadata_country/python.mdx create mode 100644 content/types/models/operations/get_metadata_country/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_director/go.mdx create mode 100644 content/types/models/operations/get_metadata_director/python.mdx create mode 100644 content/types/models/operations/get_metadata_director/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_genre/go.mdx create mode 100644 content/types/models/operations/get_metadata_genre/python.mdx create mode 100644 content/types/models/operations/get_metadata_genre/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_media/go.mdx create mode 100644 content/types/models/operations/get_metadata_media/python.mdx create mode 100644 content/types/models/operations/get_metadata_media/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_media_container/go.mdx create mode 100644 content/types/models/operations/get_metadata_media_container/python.mdx create mode 100644 content/types/models/operations/get_metadata_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_metadata/go.mdx create mode 100644 content/types/models/operations/get_metadata_metadata/python.mdx create mode 100644 content/types/models/operations/get_metadata_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_part/go.mdx create mode 100644 content/types/models/operations/get_metadata_part/python.mdx create mode 100644 content/types/models/operations/get_metadata_part/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_response_body/go.mdx create mode 100644 content/types/models/operations/get_metadata_response_body/python.mdx create mode 100644 content/types/models/operations/get_metadata_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_role/go.mdx create mode 100644 content/types/models/operations/get_metadata_role/python.mdx create mode 100644 content/types/models/operations/get_metadata_role/typescript.mdx create mode 100644 content/types/models/operations/get_metadata_writer/go.mdx create mode 100644 content/types/models/operations/get_metadata_writer/python.mdx create mode 100644 content/types/models/operations/get_metadata_writer/typescript.mdx create mode 100644 content/types/models/operations/get_on_deck_guids/go.mdx create mode 100644 content/types/models/operations/get_on_deck_guids/python.mdx create mode 100644 content/types/models/operations/get_on_deck_guids/typescript.mdx create mode 100644 content/types/models/operations/get_on_deck_stream/go.mdx create mode 100644 content/types/models/operations/get_on_deck_stream/python.mdx create mode 100644 content/types/models/operations/get_on_deck_stream/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_country/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_country/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_country/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_director/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_director/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_director/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_genre/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_genre/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_genre/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media_container/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media_container/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_metadata/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_metadata/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_part/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_part/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_part/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_response_body/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_response_body/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_role/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_role/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_role/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_contents_writer/go.mdx create mode 100644 content/types/models/operations/get_playlist_contents_writer/python.mdx create mode 100644 content/types/models/operations/get_playlist_contents_writer/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_media_container/go.mdx create mode 100644 content/types/models/operations/get_playlist_media_container/python.mdx create mode 100644 content/types/models/operations/get_playlist_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_metadata/go.mdx create mode 100644 content/types/models/operations/get_playlist_metadata/python.mdx create mode 100644 content/types/models/operations/get_playlist_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_playlist_response_body/go.mdx create mode 100644 content/types/models/operations/get_playlist_response_body/python.mdx create mode 100644 content/types/models/operations/get_playlist_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_playlists_media_container/go.mdx create mode 100644 content/types/models/operations/get_playlists_media_container/python.mdx create mode 100644 content/types/models/operations/get_playlists_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_playlists_metadata/go.mdx create mode 100644 content/types/models/operations/get_playlists_metadata/python.mdx create mode 100644 content/types/models/operations/get_playlists_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_playlists_response_body/go.mdx create mode 100644 content/types/models/operations/get_playlists_response_body/python.mdx create mode 100644 content/types/models/operations/get_playlists_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_server_preferences_media_container/go.mdx create mode 100644 content/types/models/operations/get_server_preferences_media_container/python.mdx create mode 100644 content/types/models/operations/get_server_preferences_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_server_preferences_response_body/go.mdx create mode 100644 content/types/models/operations/get_server_preferences_response_body/python.mdx create mode 100644 content/types/models/operations/get_server_preferences_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_session_history_media_container/go.mdx create mode 100644 content/types/models/operations/get_session_history_media_container/python.mdx create mode 100644 content/types/models/operations/get_session_history_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_session_history_metadata/go.mdx create mode 100644 content/types/models/operations/get_session_history_metadata/python.mdx create mode 100644 content/types/models/operations/get_session_history_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_session_history_response_body/go.mdx create mode 100644 content/types/models/operations/get_session_history_response_body/python.mdx create mode 100644 content/types/models/operations/get_session_history_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_media/go.mdx create mode 100644 content/types/models/operations/get_sessions_media/python.mdx create mode 100644 content/types/models/operations/get_sessions_media/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_media_container/go.mdx create mode 100644 content/types/models/operations/get_sessions_media_container/python.mdx create mode 100644 content/types/models/operations/get_sessions_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_metadata/go.mdx create mode 100644 content/types/models/operations/get_sessions_metadata/python.mdx create mode 100644 content/types/models/operations/get_sessions_metadata/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_part/go.mdx create mode 100644 content/types/models/operations/get_sessions_part/python.mdx create mode 100644 content/types/models/operations/get_sessions_part/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_response_body/go.mdx create mode 100644 content/types/models/operations/get_sessions_response_body/python.mdx create mode 100644 content/types/models/operations/get_sessions_response_body/typescript.mdx create mode 100644 content/types/models/operations/get_sessions_stream/go.mdx create mode 100644 content/types/models/operations/get_sessions_stream/python.mdx create mode 100644 content/types/models/operations/get_sessions_stream/typescript.mdx create mode 100644 content/types/models/operations/get_update_status_media_container/go.mdx create mode 100644 content/types/models/operations/get_update_status_media_container/python.mdx create mode 100644 content/types/models/operations/get_update_status_media_container/typescript.mdx create mode 100644 content/types/models/operations/get_update_status_response_body/go.mdx create mode 100644 content/types/models/operations/get_update_status_response_body/python.mdx create mode 100644 content/types/models/operations/get_update_status_response_body/typescript.mdx create mode 100644 content/types/models/operations/hub/go.mdx create mode 100644 content/types/models/operations/hub/python.mdx create mode 100644 content/types/models/operations/hub/typescript.mdx create mode 100644 content/types/models/operations/one/go.mdx create mode 100644 content/types/models/operations/one/python.mdx create mode 100644 content/types/models/operations/one/typescript.mdx create mode 100644 content/types/models/operations/operator/go.mdx create mode 100644 content/types/models/operations/operator/python.mdx create mode 100644 content/types/models/operations/operator/typescript.mdx create mode 100644 content/types/models/operations/player/go.mdx create mode 100644 content/types/models/operations/player/python.mdx create mode 100644 content/types/models/operations/player/typescript.mdx create mode 100644 content/types/models/operations/producer/go.mdx create mode 100644 content/types/models/operations/producer/python.mdx create mode 100644 content/types/models/operations/producer/typescript.mdx create mode 100644 content/types/models/operations/ratings/go.mdx create mode 100644 content/types/models/operations/ratings/python.mdx create mode 100644 content/types/models/operations/ratings/typescript.mdx create mode 100644 content/types/models/operations/release/go.mdx create mode 100644 content/types/models/operations/release/python.mdx create mode 100644 content/types/models/operations/release/typescript.mdx create mode 100644 content/types/models/operations/session/go.mdx create mode 100644 content/types/models/operations/session/python.mdx create mode 100644 content/types/models/operations/session/typescript.mdx create mode 100644 content/types/models/operations/setting/go.mdx create mode 100644 content/types/models/operations/setting/python.mdx create mode 100644 content/types/models/operations/setting/typescript.mdx create mode 100644 content/types/models/operations/sort/go.mdx create mode 100644 content/types/models/operations/sort/python.mdx create mode 100644 content/types/models/operations/sort/typescript.mdx create mode 100644 content/types/models/operations/tag/go.mdx create mode 100644 content/types/models/operations/tag/python.mdx create mode 100644 content/types/models/operations/tag/typescript.mdx create mode 100644 content/types/models/operations/two/go.mdx create mode 100644 content/types/models/operations/two/python.mdx create mode 100644 content/types/models/operations/two/typescript.mdx create mode 100644 content/types/models/operations/user/go.mdx create mode 100644 content/types/models/operations/user/python.mdx create mode 100644 content/types/models/operations/user/typescript.mdx delete mode 100644 content/types/models/sdkerrors/get_common_library_items_errors/go.mdx delete mode 100644 content/types/models/sdkerrors/get_common_library_items_response_body/go.mdx delete mode 100644 content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx delete mode 100644 content/types/models/sdkerrors/get_latest_library_items_response_body/go.mdx delete mode 100644 content/types/models/sdkerrors/get_library_items_errors/go.mdx delete mode 100644 content/types/models/sdkerrors/get_library_items_response_body/go.mdx create mode 100644 content/types/operations/add_playlist_contents_media_container/curl.mdx create mode 100644 content/types/operations/add_playlist_contents_metadata/curl.mdx rename content/types/operations/{get_common_library_items_response_body => add_playlist_contents_playlists_response_body}/curl.mdx (100%) create mode 100644 content/types/operations/create_playlist_media_container/curl.mdx create mode 100644 content/types/operations/create_playlist_metadata/curl.mdx rename content/types/operations/{get_latest_library_items_response_body => create_playlist_playlists_response_body}/curl.mdx (100%) create mode 100644 content/types/operations/field/curl.mdx create mode 100644 content/types/operations/field_type/curl.mdx create mode 100644 content/types/operations/filter/curl.mdx create mode 100644 content/types/operations/get_available_clients_server_response_body/curl.mdx delete mode 100644 content/types/operations/get_common_library_items_errors/curl.mdx delete mode 100644 content/types/operations/get_common_library_items_request/curl.mdx delete mode 100644 content/types/operations/get_common_library_items_response/curl.mdx create mode 100644 content/types/operations/get_global_hubs_hubs_response_body/curl.mdx create mode 100644 content/types/operations/get_global_hubs_media_container/curl.mdx create mode 100644 content/types/operations/get_global_hubs_metadata/curl.mdx delete mode 100644 content/types/operations/get_latest_library_items_errors/curl.mdx delete mode 100644 content/types/operations/get_latest_library_items_request/curl.mdx delete mode 100644 content/types/operations/get_latest_library_items_response/curl.mdx create mode 100644 content/types/operations/get_library_directory/curl.mdx create mode 100644 content/types/operations/get_library_hubs_country/curl.mdx create mode 100644 content/types/operations/get_library_hubs_director/curl.mdx create mode 100644 content/types/operations/get_library_hubs_genre/curl.mdx create mode 100644 content/types/operations/get_library_hubs_hub/curl.mdx create mode 100644 content/types/operations/get_library_hubs_hubs_response_body/curl.mdx create mode 100644 content/types/operations/get_library_hubs_media/curl.mdx create mode 100644 content/types/operations/get_library_hubs_media_container/curl.mdx create mode 100644 content/types/operations/get_library_hubs_metadata/curl.mdx create mode 100644 content/types/operations/get_library_hubs_part/curl.mdx create mode 100644 content/types/operations/get_library_hubs_role/curl.mdx create mode 100644 content/types/operations/get_library_hubs_writer/curl.mdx create mode 100644 content/types/operations/get_library_items_country/curl.mdx create mode 100644 content/types/operations/get_library_items_director/curl.mdx delete mode 100644 content/types/operations/get_library_items_errors/curl.mdx create mode 100644 content/types/operations/get_library_items_genre/curl.mdx create mode 100644 content/types/operations/get_library_items_media/curl.mdx create mode 100644 content/types/operations/get_library_items_media_container/curl.mdx create mode 100644 content/types/operations/get_library_items_metadata/curl.mdx create mode 100644 content/types/operations/get_library_items_part/curl.mdx create mode 100644 content/types/operations/get_library_items_role/curl.mdx create mode 100644 content/types/operations/get_library_items_writer/curl.mdx create mode 100644 content/types/operations/get_library_library_response_body/curl.mdx create mode 100644 content/types/operations/get_library_media_container/curl.mdx create mode 100644 content/types/operations/get_library_type/curl.mdx create mode 100644 content/types/operations/get_metadata_children_directory/curl.mdx create mode 100644 content/types/operations/get_metadata_children_library_response_body/curl.mdx create mode 100644 content/types/operations/get_metadata_children_media_container/curl.mdx create mode 100644 content/types/operations/get_metadata_children_metadata/curl.mdx create mode 100644 content/types/operations/get_metadata_country/curl.mdx create mode 100644 content/types/operations/get_metadata_director/curl.mdx create mode 100644 content/types/operations/get_metadata_genre/curl.mdx create mode 100644 content/types/operations/get_metadata_library_response_body/curl.mdx create mode 100644 content/types/operations/get_metadata_media/curl.mdx create mode 100644 content/types/operations/get_metadata_media_container/curl.mdx create mode 100644 content/types/operations/get_metadata_metadata/curl.mdx create mode 100644 content/types/operations/get_metadata_part/curl.mdx create mode 100644 content/types/operations/get_metadata_role/curl.mdx create mode 100644 content/types/operations/get_metadata_writer/curl.mdx create mode 100644 content/types/operations/get_on_deck_guids/curl.mdx create mode 100644 content/types/operations/get_on_deck_stream/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_country/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_director/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_genre/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_media/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_media_container/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_metadata/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_part/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_role/curl.mdx create mode 100644 content/types/operations/get_playlist_contents_writer/curl.mdx create mode 100644 content/types/operations/get_playlist_media_container/curl.mdx create mode 100644 content/types/operations/get_playlist_metadata/curl.mdx create mode 100644 content/types/operations/get_playlist_playlists_response_body/curl.mdx create mode 100644 content/types/operations/get_playlists_media_container/curl.mdx create mode 100644 content/types/operations/get_playlists_metadata/curl.mdx create mode 100644 content/types/operations/get_playlists_playlists_response_body/curl.mdx create mode 100644 content/types/operations/get_server_preferences_media_container/curl.mdx create mode 100644 content/types/operations/get_server_preferences_server_response_body/curl.mdx create mode 100644 content/types/operations/get_session_history_media_container/curl.mdx create mode 100644 content/types/operations/get_session_history_metadata/curl.mdx create mode 100644 content/types/operations/get_session_history_sessions_response_body/curl.mdx create mode 100644 content/types/operations/get_sessions_media/curl.mdx create mode 100644 content/types/operations/get_sessions_media_container/curl.mdx create mode 100644 content/types/operations/get_sessions_metadata/curl.mdx create mode 100644 content/types/operations/get_sessions_part/curl.mdx create mode 100644 content/types/operations/get_sessions_sessions_response_body/curl.mdx create mode 100644 content/types/operations/get_sessions_stream/curl.mdx create mode 100644 content/types/operations/get_update_status_media_container/curl.mdx create mode 100644 content/types/operations/get_update_status_updater_response_body/curl.mdx create mode 100644 content/types/operations/hub/curl.mdx create mode 100644 content/types/operations/log_multi_line_request_body/curl.mdx create mode 100644 content/types/operations/one/curl.mdx create mode 100644 content/types/operations/operator/curl.mdx create mode 100644 content/types/operations/player/curl.mdx create mode 100644 content/types/operations/producer/curl.mdx create mode 100644 content/types/operations/ratings/curl.mdx create mode 100644 content/types/operations/release/curl.mdx delete mode 100644 content/types/operations/response_body/curl.mdx create mode 100644 content/types/operations/session/curl.mdx create mode 100644 content/types/operations/setting/curl.mdx create mode 100644 content/types/operations/sort/curl.mdx create mode 100644 content/types/operations/tag/curl.mdx create mode 100644 content/types/operations/two/curl.mdx create mode 100644 content/types/operations/user/curl.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items_content.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx delete mode 100644 src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items_content.mdx diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index c4f5b3c..a501365 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 7fc33f51-d778-40ef-b094-90972c025d39 management: - docChecksum: d7e0ebb6913e00a62d90ea05f2e5542d + docChecksum: 7aba498c024534142941d65a7c2e649c docVersion: 0.0.3 speakeasyVersion: internal - generationVersion: 2.237.2 - releaseVersion: 0.1.1 - configChecksum: 0c20dc849e2f416cfc75b0f5279fd965 + generationVersion: 2.237.3 + releaseVersion: 0.2.0 + configChecksum: 7adcc65dd0834e56b5a7642677ff9159 published: true features: docs: @@ -16,6 +16,7 @@ features: globalSecurity: 0.1.1 globalServerURLs: 0.1.1 nameOverrides: 0.1.0 + unions: 0.1.2 generatedFiles: - content/pages/01-reference/go/client_sdks/_snippet.mdx - content/pages/01-reference/go/client_sdks/client_sdks.mdx @@ -75,21 +76,11 @@ generatedFiles: - content/pages/01-reference/go/resources/library/delete_library/_response.mdx - content/pages/01-reference/go/resources/library/delete_library/_usage.mdx - content/pages/01-reference/go/resources/library/delete_library/delete_library.mdx - - content/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx - - content/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx - - content/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx - - content/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx - - content/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx - content/pages/01-reference/go/resources/library/get_file_hash/_header.mdx - content/pages/01-reference/go/resources/library/get_file_hash/_parameters.mdx - content/pages/01-reference/go/resources/library/get_file_hash/_response.mdx - content/pages/01-reference/go/resources/library/get_file_hash/_usage.mdx - content/pages/01-reference/go/resources/library/get_file_hash/get_file_hash.mdx - - content/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx - - content/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx - - content/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx - - content/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx - - content/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx - content/pages/01-reference/go/resources/library/get_libraries/_header.mdx - content/pages/01-reference/go/resources/library/get_libraries/_parameters.mdx - content/pages/01-reference/go/resources/library/get_libraries/_response.mdx @@ -385,21 +376,11 @@ generatedFiles: - content/pages/01-reference/python/resources/library/delete_library/_response.mdx - content/pages/01-reference/python/resources/library/delete_library/_usage.mdx - content/pages/01-reference/python/resources/library/delete_library/delete_library.mdx - - content/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx - - content/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx - - content/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx - - content/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx - - content/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx - content/pages/01-reference/python/resources/library/get_file_hash/_header.mdx - content/pages/01-reference/python/resources/library/get_file_hash/_parameters.mdx - content/pages/01-reference/python/resources/library/get_file_hash/_response.mdx - content/pages/01-reference/python/resources/library/get_file_hash/_usage.mdx - content/pages/01-reference/python/resources/library/get_file_hash/get_file_hash.mdx - - content/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx - - content/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx - - content/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx - - content/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx - - content/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx - content/pages/01-reference/python/resources/library/get_libraries/_header.mdx - content/pages/01-reference/python/resources/library/get_libraries/_parameters.mdx - content/pages/01-reference/python/resources/library/get_libraries/_response.mdx @@ -695,21 +676,11 @@ generatedFiles: - content/pages/01-reference/typescript/resources/library/delete_library/_response.mdx - content/pages/01-reference/typescript/resources/library/delete_library/_usage.mdx - content/pages/01-reference/typescript/resources/library/delete_library/delete_library.mdx - - content/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx - - content/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx - - content/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx - - content/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx - - content/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx - content/pages/01-reference/typescript/resources/library/get_file_hash/_header.mdx - content/pages/01-reference/typescript/resources/library/get_file_hash/_parameters.mdx - content/pages/01-reference/typescript/resources/library/get_file_hash/_response.mdx - content/pages/01-reference/typescript/resources/library/get_file_hash/_usage.mdx - content/pages/01-reference/typescript/resources/library/get_file_hash/get_file_hash.mdx - - content/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx - - content/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx - - content/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx - - content/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx - - content/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx - content/pages/01-reference/typescript/resources/library/get_libraries/_header.mdx - content/pages/01-reference/typescript/resources/library/get_libraries/_parameters.mdx - content/pages/01-reference/typescript/resources/library/get_libraries/_response.mdx @@ -996,10 +967,6 @@ generatedFiles: - content/types/models/errors/get_butler_tasks_errors/typescript.mdx - content/types/models/errors/get_butler_tasks_response_body/python.mdx - content/types/models/errors/get_butler_tasks_response_body/typescript.mdx - - content/types/models/errors/get_common_library_items_errors/python.mdx - - content/types/models/errors/get_common_library_items_errors/typescript.mdx - - content/types/models/errors/get_common_library_items_response_body/python.mdx - - content/types/models/errors/get_common_library_items_response_body/typescript.mdx - content/types/models/errors/get_devices_errors/python.mdx - content/types/models/errors/get_devices_errors/typescript.mdx - content/types/models/errors/get_devices_response_body/python.mdx @@ -1012,10 +979,6 @@ generatedFiles: - content/types/models/errors/get_global_hubs_errors/typescript.mdx - content/types/models/errors/get_global_hubs_response_body/python.mdx - content/types/models/errors/get_global_hubs_response_body/typescript.mdx - - content/types/models/errors/get_latest_library_items_errors/python.mdx - - content/types/models/errors/get_latest_library_items_errors/typescript.mdx - - content/types/models/errors/get_latest_library_items_response_body/python.mdx - - content/types/models/errors/get_latest_library_items_response_body/typescript.mdx - content/types/models/errors/get_libraries_errors/python.mdx - content/types/models/errors/get_libraries_errors/typescript.mdx - content/types/models/errors/get_libraries_response_body/python.mdx @@ -1026,10 +989,6 @@ generatedFiles: - content/types/models/errors/get_library_hubs_errors/typescript.mdx - content/types/models/errors/get_library_hubs_response_body/python.mdx - content/types/models/errors/get_library_hubs_response_body/typescript.mdx - - content/types/models/errors/get_library_items_errors/python.mdx - - content/types/models/errors/get_library_items_errors/typescript.mdx - - content/types/models/errors/get_library_items_response_body/python.mdx - - content/types/models/errors/get_library_items_response_body/typescript.mdx - content/types/models/errors/get_library_response_body/python.mdx - content/types/models/errors/get_library_response_body/typescript.mdx - content/types/models/errors/get_metadata_children_errors/python.mdx @@ -1185,12 +1144,21 @@ generatedFiles: - content/types/models/operations/activity/go.mdx - content/types/models/operations/activity/python.mdx - content/types/models/operations/activity/typescript.mdx + - content/types/models/operations/add_playlist_contents_media_container/go.mdx + - content/types/models/operations/add_playlist_contents_media_container/python.mdx + - content/types/models/operations/add_playlist_contents_media_container/typescript.mdx + - content/types/models/operations/add_playlist_contents_metadata/go.mdx + - content/types/models/operations/add_playlist_contents_metadata/python.mdx + - content/types/models/operations/add_playlist_contents_metadata/typescript.mdx - content/types/models/operations/add_playlist_contents_request/go.mdx - content/types/models/operations/add_playlist_contents_request/python.mdx - content/types/models/operations/add_playlist_contents_request/typescript.mdx - content/types/models/operations/add_playlist_contents_response/go.mdx - content/types/models/operations/add_playlist_contents_response/python.mdx - content/types/models/operations/add_playlist_contents_response/typescript.mdx + - content/types/models/operations/add_playlist_contents_response_body/go.mdx + - content/types/models/operations/add_playlist_contents_response_body/python.mdx + - content/types/models/operations/add_playlist_contents_response_body/typescript.mdx - content/types/models/operations/apply_updates_request/go.mdx - content/types/models/operations/apply_updates_request/python.mdx - content/types/models/operations/apply_updates_request/typescript.mdx @@ -1227,12 +1195,21 @@ generatedFiles: - content/types/models/operations/country/go.mdx - content/types/models/operations/country/python.mdx - content/types/models/operations/country/typescript.mdx + - content/types/models/operations/create_playlist_media_container/go.mdx + - content/types/models/operations/create_playlist_media_container/python.mdx + - content/types/models/operations/create_playlist_media_container/typescript.mdx + - content/types/models/operations/create_playlist_metadata/go.mdx + - content/types/models/operations/create_playlist_metadata/python.mdx + - content/types/models/operations/create_playlist_metadata/typescript.mdx - content/types/models/operations/create_playlist_request/go.mdx - content/types/models/operations/create_playlist_request/python.mdx - content/types/models/operations/create_playlist_request/typescript.mdx - content/types/models/operations/create_playlist_response/go.mdx - content/types/models/operations/create_playlist_response/python.mdx - content/types/models/operations/create_playlist_response/typescript.mdx + - content/types/models/operations/create_playlist_response_body/go.mdx + - content/types/models/operations/create_playlist_response_body/python.mdx + - content/types/models/operations/create_playlist_response_body/typescript.mdx - content/types/models/operations/delete_library_request/go.mdx - content/types/models/operations/delete_library_request/python.mdx - content/types/models/operations/delete_library_request/typescript.mdx @@ -1260,6 +1237,15 @@ generatedFiles: - content/types/models/operations/enable_paper_trail_response/go.mdx - content/types/models/operations/enable_paper_trail_response/python.mdx - content/types/models/operations/enable_paper_trail_response/typescript.mdx + - content/types/models/operations/field/go.mdx + - content/types/models/operations/field/python.mdx + - content/types/models/operations/field/typescript.mdx + - content/types/models/operations/field_type/go.mdx + - content/types/models/operations/field_type/python.mdx + - content/types/models/operations/field_type/typescript.mdx + - content/types/models/operations/filter/go.mdx + - content/types/models/operations/filter/python.mdx + - content/types/models/operations/filter/typescript.mdx - content/types/models/operations/force/go.mdx - content/types/models/operations/force/python.mdx - content/types/models/operations/force/typescript.mdx @@ -1272,18 +1258,15 @@ generatedFiles: - content/types/models/operations/get_available_clients_response/go.mdx - content/types/models/operations/get_available_clients_response/python.mdx - content/types/models/operations/get_available_clients_response/typescript.mdx + - content/types/models/operations/get_available_clients_response_body/go.mdx + - content/types/models/operations/get_available_clients_response_body/python.mdx + - content/types/models/operations/get_available_clients_response_body/typescript.mdx - content/types/models/operations/get_butler_tasks_response/go.mdx - content/types/models/operations/get_butler_tasks_response/python.mdx - content/types/models/operations/get_butler_tasks_response/typescript.mdx - content/types/models/operations/get_butler_tasks_response_body/go.mdx - content/types/models/operations/get_butler_tasks_response_body/python.mdx - content/types/models/operations/get_butler_tasks_response_body/typescript.mdx - - content/types/models/operations/get_common_library_items_request/go.mdx - - content/types/models/operations/get_common_library_items_request/python.mdx - - content/types/models/operations/get_common_library_items_request/typescript.mdx - - content/types/models/operations/get_common_library_items_response/go.mdx - - content/types/models/operations/get_common_library_items_response/python.mdx - - content/types/models/operations/get_common_library_items_response/typescript.mdx - content/types/models/operations/get_devices_media_container/go.mdx - content/types/models/operations/get_devices_media_container/python.mdx - content/types/models/operations/get_devices_media_container/typescript.mdx @@ -1299,18 +1282,21 @@ generatedFiles: - content/types/models/operations/get_file_hash_response/go.mdx - content/types/models/operations/get_file_hash_response/python.mdx - content/types/models/operations/get_file_hash_response/typescript.mdx + - content/types/models/operations/get_global_hubs_media_container/go.mdx + - content/types/models/operations/get_global_hubs_media_container/python.mdx + - content/types/models/operations/get_global_hubs_media_container/typescript.mdx + - content/types/models/operations/get_global_hubs_metadata/go.mdx + - content/types/models/operations/get_global_hubs_metadata/python.mdx + - content/types/models/operations/get_global_hubs_metadata/typescript.mdx - content/types/models/operations/get_global_hubs_request/go.mdx - content/types/models/operations/get_global_hubs_request/python.mdx - content/types/models/operations/get_global_hubs_request/typescript.mdx - content/types/models/operations/get_global_hubs_response/go.mdx - content/types/models/operations/get_global_hubs_response/python.mdx - content/types/models/operations/get_global_hubs_response/typescript.mdx - - content/types/models/operations/get_latest_library_items_request/go.mdx - - content/types/models/operations/get_latest_library_items_request/python.mdx - - content/types/models/operations/get_latest_library_items_request/typescript.mdx - - content/types/models/operations/get_latest_library_items_response/go.mdx - - content/types/models/operations/get_latest_library_items_response/python.mdx - - content/types/models/operations/get_latest_library_items_response/typescript.mdx + - content/types/models/operations/get_global_hubs_response_body/go.mdx + - content/types/models/operations/get_global_hubs_response_body/python.mdx + - content/types/models/operations/get_global_hubs_response_body/typescript.mdx - content/types/models/operations/get_libraries_directory/go.mdx - content/types/models/operations/get_libraries_directory/python.mdx - content/types/models/operations/get_libraries_directory/typescript.mdx @@ -1323,42 +1309,162 @@ generatedFiles: - content/types/models/operations/get_libraries_response_body/go.mdx - content/types/models/operations/get_libraries_response_body/python.mdx - content/types/models/operations/get_libraries_response_body/typescript.mdx + - content/types/models/operations/get_library_directory/go.mdx + - content/types/models/operations/get_library_directory/python.mdx + - content/types/models/operations/get_library_directory/typescript.mdx + - content/types/models/operations/get_library_hubs_country/go.mdx + - content/types/models/operations/get_library_hubs_country/python.mdx + - content/types/models/operations/get_library_hubs_country/typescript.mdx + - content/types/models/operations/get_library_hubs_director/go.mdx + - content/types/models/operations/get_library_hubs_director/python.mdx + - content/types/models/operations/get_library_hubs_director/typescript.mdx + - content/types/models/operations/get_library_hubs_genre/go.mdx + - content/types/models/operations/get_library_hubs_genre/python.mdx + - content/types/models/operations/get_library_hubs_genre/typescript.mdx + - content/types/models/operations/get_library_hubs_hub/go.mdx + - content/types/models/operations/get_library_hubs_hub/python.mdx + - content/types/models/operations/get_library_hubs_hub/typescript.mdx + - content/types/models/operations/get_library_hubs_media/go.mdx + - content/types/models/operations/get_library_hubs_media/python.mdx + - content/types/models/operations/get_library_hubs_media/typescript.mdx + - content/types/models/operations/get_library_hubs_media_container/go.mdx + - content/types/models/operations/get_library_hubs_media_container/python.mdx + - content/types/models/operations/get_library_hubs_media_container/typescript.mdx + - content/types/models/operations/get_library_hubs_metadata/go.mdx + - content/types/models/operations/get_library_hubs_metadata/python.mdx + - content/types/models/operations/get_library_hubs_metadata/typescript.mdx + - content/types/models/operations/get_library_hubs_part/go.mdx + - content/types/models/operations/get_library_hubs_part/python.mdx + - content/types/models/operations/get_library_hubs_part/typescript.mdx - content/types/models/operations/get_library_hubs_request/go.mdx - content/types/models/operations/get_library_hubs_request/python.mdx - content/types/models/operations/get_library_hubs_request/typescript.mdx - content/types/models/operations/get_library_hubs_response/go.mdx - content/types/models/operations/get_library_hubs_response/python.mdx - content/types/models/operations/get_library_hubs_response/typescript.mdx + - content/types/models/operations/get_library_hubs_response_body/go.mdx + - content/types/models/operations/get_library_hubs_response_body/python.mdx + - content/types/models/operations/get_library_hubs_response_body/typescript.mdx + - content/types/models/operations/get_library_hubs_role/go.mdx + - content/types/models/operations/get_library_hubs_role/python.mdx + - content/types/models/operations/get_library_hubs_role/typescript.mdx + - content/types/models/operations/get_library_hubs_writer/go.mdx + - content/types/models/operations/get_library_hubs_writer/python.mdx + - content/types/models/operations/get_library_hubs_writer/typescript.mdx + - content/types/models/operations/get_library_items_country/go.mdx + - content/types/models/operations/get_library_items_country/python.mdx + - content/types/models/operations/get_library_items_country/typescript.mdx + - content/types/models/operations/get_library_items_director/go.mdx + - content/types/models/operations/get_library_items_director/python.mdx + - content/types/models/operations/get_library_items_director/typescript.mdx + - content/types/models/operations/get_library_items_genre/go.mdx + - content/types/models/operations/get_library_items_genre/python.mdx + - content/types/models/operations/get_library_items_genre/typescript.mdx + - content/types/models/operations/get_library_items_media/go.mdx + - content/types/models/operations/get_library_items_media/python.mdx + - content/types/models/operations/get_library_items_media/typescript.mdx + - content/types/models/operations/get_library_items_media_container/go.mdx + - content/types/models/operations/get_library_items_media_container/python.mdx + - content/types/models/operations/get_library_items_media_container/typescript.mdx + - content/types/models/operations/get_library_items_metadata/go.mdx + - content/types/models/operations/get_library_items_metadata/python.mdx + - content/types/models/operations/get_library_items_metadata/typescript.mdx + - content/types/models/operations/get_library_items_part/go.mdx + - content/types/models/operations/get_library_items_part/python.mdx + - content/types/models/operations/get_library_items_part/typescript.mdx - content/types/models/operations/get_library_items_request/go.mdx - content/types/models/operations/get_library_items_request/python.mdx - content/types/models/operations/get_library_items_request/typescript.mdx - content/types/models/operations/get_library_items_response/go.mdx - content/types/models/operations/get_library_items_response/python.mdx - content/types/models/operations/get_library_items_response/typescript.mdx + - content/types/models/operations/get_library_items_response_body/go.mdx + - content/types/models/operations/get_library_items_response_body/python.mdx + - content/types/models/operations/get_library_items_response_body/typescript.mdx + - content/types/models/operations/get_library_items_role/go.mdx + - content/types/models/operations/get_library_items_role/python.mdx + - content/types/models/operations/get_library_items_role/typescript.mdx + - content/types/models/operations/get_library_items_writer/go.mdx + - content/types/models/operations/get_library_items_writer/python.mdx + - content/types/models/operations/get_library_items_writer/typescript.mdx + - content/types/models/operations/get_library_media_container/go.mdx + - content/types/models/operations/get_library_media_container/python.mdx + - content/types/models/operations/get_library_media_container/typescript.mdx - content/types/models/operations/get_library_request/go.mdx - content/types/models/operations/get_library_request/python.mdx - content/types/models/operations/get_library_request/typescript.mdx - content/types/models/operations/get_library_response/go.mdx - content/types/models/operations/get_library_response/python.mdx - content/types/models/operations/get_library_response/typescript.mdx + - content/types/models/operations/get_library_response_body/go.mdx + - content/types/models/operations/get_library_response_body/python.mdx + - content/types/models/operations/get_library_response_body/typescript.mdx + - content/types/models/operations/get_library_type/go.mdx + - content/types/models/operations/get_library_type/python.mdx + - content/types/models/operations/get_library_type/typescript.mdx + - content/types/models/operations/get_metadata_children_directory/go.mdx + - content/types/models/operations/get_metadata_children_directory/python.mdx + - content/types/models/operations/get_metadata_children_directory/typescript.mdx + - content/types/models/operations/get_metadata_children_media_container/go.mdx + - content/types/models/operations/get_metadata_children_media_container/python.mdx + - content/types/models/operations/get_metadata_children_media_container/typescript.mdx + - content/types/models/operations/get_metadata_children_metadata/go.mdx + - content/types/models/operations/get_metadata_children_metadata/python.mdx + - content/types/models/operations/get_metadata_children_metadata/typescript.mdx - content/types/models/operations/get_metadata_children_request/go.mdx - content/types/models/operations/get_metadata_children_request/python.mdx - content/types/models/operations/get_metadata_children_request/typescript.mdx - content/types/models/operations/get_metadata_children_response/go.mdx - content/types/models/operations/get_metadata_children_response/python.mdx - content/types/models/operations/get_metadata_children_response/typescript.mdx + - content/types/models/operations/get_metadata_children_response_body/go.mdx + - content/types/models/operations/get_metadata_children_response_body/python.mdx + - content/types/models/operations/get_metadata_children_response_body/typescript.mdx + - content/types/models/operations/get_metadata_country/go.mdx + - content/types/models/operations/get_metadata_country/python.mdx + - content/types/models/operations/get_metadata_country/typescript.mdx + - content/types/models/operations/get_metadata_director/go.mdx + - content/types/models/operations/get_metadata_director/python.mdx + - content/types/models/operations/get_metadata_director/typescript.mdx + - content/types/models/operations/get_metadata_genre/go.mdx + - content/types/models/operations/get_metadata_genre/python.mdx + - content/types/models/operations/get_metadata_genre/typescript.mdx + - content/types/models/operations/get_metadata_media/go.mdx + - content/types/models/operations/get_metadata_media/python.mdx + - content/types/models/operations/get_metadata_media/typescript.mdx + - content/types/models/operations/get_metadata_media_container/go.mdx + - content/types/models/operations/get_metadata_media_container/python.mdx + - content/types/models/operations/get_metadata_media_container/typescript.mdx + - content/types/models/operations/get_metadata_metadata/go.mdx + - content/types/models/operations/get_metadata_metadata/python.mdx + - content/types/models/operations/get_metadata_metadata/typescript.mdx + - content/types/models/operations/get_metadata_part/go.mdx + - content/types/models/operations/get_metadata_part/python.mdx + - content/types/models/operations/get_metadata_part/typescript.mdx - content/types/models/operations/get_metadata_request/go.mdx - content/types/models/operations/get_metadata_request/python.mdx - content/types/models/operations/get_metadata_request/typescript.mdx - content/types/models/operations/get_metadata_response/go.mdx - content/types/models/operations/get_metadata_response/python.mdx - content/types/models/operations/get_metadata_response/typescript.mdx + - content/types/models/operations/get_metadata_response_body/go.mdx + - content/types/models/operations/get_metadata_response_body/python.mdx + - content/types/models/operations/get_metadata_response_body/typescript.mdx + - content/types/models/operations/get_metadata_role/go.mdx + - content/types/models/operations/get_metadata_role/python.mdx + - content/types/models/operations/get_metadata_role/typescript.mdx + - content/types/models/operations/get_metadata_writer/go.mdx + - content/types/models/operations/get_metadata_writer/python.mdx + - content/types/models/operations/get_metadata_writer/typescript.mdx - content/types/models/operations/get_my_plex_account_response/go.mdx - content/types/models/operations/get_my_plex_account_response/python.mdx - content/types/models/operations/get_my_plex_account_response/typescript.mdx - content/types/models/operations/get_my_plex_account_response_body/go.mdx - content/types/models/operations/get_my_plex_account_response_body/python.mdx - content/types/models/operations/get_my_plex_account_response_body/typescript.mdx + - content/types/models/operations/get_on_deck_guids/go.mdx + - content/types/models/operations/get_on_deck_guids/python.mdx + - content/types/models/operations/get_on_deck_guids/typescript.mdx - content/types/models/operations/get_on_deck_media/go.mdx - content/types/models/operations/get_on_deck_media/python.mdx - content/types/models/operations/get_on_deck_media/typescript.mdx @@ -1377,24 +1483,75 @@ generatedFiles: - content/types/models/operations/get_on_deck_response_body/go.mdx - content/types/models/operations/get_on_deck_response_body/python.mdx - content/types/models/operations/get_on_deck_response_body/typescript.mdx + - content/types/models/operations/get_on_deck_stream/go.mdx + - content/types/models/operations/get_on_deck_stream/python.mdx + - content/types/models/operations/get_on_deck_stream/typescript.mdx + - content/types/models/operations/get_playlist_contents_country/go.mdx + - content/types/models/operations/get_playlist_contents_country/python.mdx + - content/types/models/operations/get_playlist_contents_country/typescript.mdx + - content/types/models/operations/get_playlist_contents_director/go.mdx + - content/types/models/operations/get_playlist_contents_director/python.mdx + - content/types/models/operations/get_playlist_contents_director/typescript.mdx + - content/types/models/operations/get_playlist_contents_genre/go.mdx + - content/types/models/operations/get_playlist_contents_genre/python.mdx + - content/types/models/operations/get_playlist_contents_genre/typescript.mdx + - content/types/models/operations/get_playlist_contents_media/go.mdx + - content/types/models/operations/get_playlist_contents_media/python.mdx + - content/types/models/operations/get_playlist_contents_media/typescript.mdx + - content/types/models/operations/get_playlist_contents_media_container/go.mdx + - content/types/models/operations/get_playlist_contents_media_container/python.mdx + - content/types/models/operations/get_playlist_contents_media_container/typescript.mdx + - content/types/models/operations/get_playlist_contents_metadata/go.mdx + - content/types/models/operations/get_playlist_contents_metadata/python.mdx + - content/types/models/operations/get_playlist_contents_metadata/typescript.mdx + - content/types/models/operations/get_playlist_contents_part/go.mdx + - content/types/models/operations/get_playlist_contents_part/python.mdx + - content/types/models/operations/get_playlist_contents_part/typescript.mdx - content/types/models/operations/get_playlist_contents_request/go.mdx - content/types/models/operations/get_playlist_contents_request/python.mdx - content/types/models/operations/get_playlist_contents_request/typescript.mdx - content/types/models/operations/get_playlist_contents_response/go.mdx - content/types/models/operations/get_playlist_contents_response/python.mdx - content/types/models/operations/get_playlist_contents_response/typescript.mdx + - content/types/models/operations/get_playlist_contents_response_body/go.mdx + - content/types/models/operations/get_playlist_contents_response_body/python.mdx + - content/types/models/operations/get_playlist_contents_response_body/typescript.mdx + - content/types/models/operations/get_playlist_contents_role/go.mdx + - content/types/models/operations/get_playlist_contents_role/python.mdx + - content/types/models/operations/get_playlist_contents_role/typescript.mdx + - content/types/models/operations/get_playlist_contents_writer/go.mdx + - content/types/models/operations/get_playlist_contents_writer/python.mdx + - content/types/models/operations/get_playlist_contents_writer/typescript.mdx + - content/types/models/operations/get_playlist_media_container/go.mdx + - content/types/models/operations/get_playlist_media_container/python.mdx + - content/types/models/operations/get_playlist_media_container/typescript.mdx + - content/types/models/operations/get_playlist_metadata/go.mdx + - content/types/models/operations/get_playlist_metadata/python.mdx + - content/types/models/operations/get_playlist_metadata/typescript.mdx - content/types/models/operations/get_playlist_request/go.mdx - content/types/models/operations/get_playlist_request/python.mdx - content/types/models/operations/get_playlist_request/typescript.mdx - content/types/models/operations/get_playlist_response/go.mdx - content/types/models/operations/get_playlist_response/python.mdx - content/types/models/operations/get_playlist_response/typescript.mdx + - content/types/models/operations/get_playlist_response_body/go.mdx + - content/types/models/operations/get_playlist_response_body/python.mdx + - content/types/models/operations/get_playlist_response_body/typescript.mdx + - content/types/models/operations/get_playlists_media_container/go.mdx + - content/types/models/operations/get_playlists_media_container/python.mdx + - content/types/models/operations/get_playlists_media_container/typescript.mdx + - content/types/models/operations/get_playlists_metadata/go.mdx + - content/types/models/operations/get_playlists_metadata/python.mdx + - content/types/models/operations/get_playlists_metadata/typescript.mdx - content/types/models/operations/get_playlists_request/go.mdx - content/types/models/operations/get_playlists_request/python.mdx - content/types/models/operations/get_playlists_request/typescript.mdx - content/types/models/operations/get_playlists_response/go.mdx - content/types/models/operations/get_playlists_response/python.mdx - content/types/models/operations/get_playlists_response/typescript.mdx + - content/types/models/operations/get_playlists_response_body/go.mdx + - content/types/models/operations/get_playlists_response_body/python.mdx + - content/types/models/operations/get_playlists_response_body/typescript.mdx - content/types/models/operations/get_recently_added_media_container/go.mdx - content/types/models/operations/get_recently_added_media_container/python.mdx - content/types/models/operations/get_recently_added_media_container/typescript.mdx @@ -1482,15 +1639,48 @@ generatedFiles: - content/types/models/operations/get_server_list_server/go.mdx - content/types/models/operations/get_server_list_server/python.mdx - content/types/models/operations/get_server_list_server/typescript.mdx + - content/types/models/operations/get_server_preferences_media_container/go.mdx + - content/types/models/operations/get_server_preferences_media_container/python.mdx + - content/types/models/operations/get_server_preferences_media_container/typescript.mdx - content/types/models/operations/get_server_preferences_response/go.mdx - content/types/models/operations/get_server_preferences_response/python.mdx - content/types/models/operations/get_server_preferences_response/typescript.mdx + - content/types/models/operations/get_server_preferences_response_body/go.mdx + - content/types/models/operations/get_server_preferences_response_body/python.mdx + - content/types/models/operations/get_server_preferences_response_body/typescript.mdx + - content/types/models/operations/get_session_history_media_container/go.mdx + - content/types/models/operations/get_session_history_media_container/python.mdx + - content/types/models/operations/get_session_history_media_container/typescript.mdx + - content/types/models/operations/get_session_history_metadata/go.mdx + - content/types/models/operations/get_session_history_metadata/python.mdx + - content/types/models/operations/get_session_history_metadata/typescript.mdx - content/types/models/operations/get_session_history_response/go.mdx - content/types/models/operations/get_session_history_response/python.mdx - content/types/models/operations/get_session_history_response/typescript.mdx + - content/types/models/operations/get_session_history_response_body/go.mdx + - content/types/models/operations/get_session_history_response_body/python.mdx + - content/types/models/operations/get_session_history_response_body/typescript.mdx + - content/types/models/operations/get_sessions_media/go.mdx + - content/types/models/operations/get_sessions_media/python.mdx + - content/types/models/operations/get_sessions_media/typescript.mdx + - content/types/models/operations/get_sessions_media_container/go.mdx + - content/types/models/operations/get_sessions_media_container/python.mdx + - content/types/models/operations/get_sessions_media_container/typescript.mdx + - content/types/models/operations/get_sessions_metadata/go.mdx + - content/types/models/operations/get_sessions_metadata/python.mdx + - content/types/models/operations/get_sessions_metadata/typescript.mdx + - content/types/models/operations/get_sessions_part/go.mdx + - content/types/models/operations/get_sessions_part/python.mdx + - content/types/models/operations/get_sessions_part/typescript.mdx - content/types/models/operations/get_sessions_response/go.mdx - content/types/models/operations/get_sessions_response/python.mdx - content/types/models/operations/get_sessions_response/typescript.mdx + - content/types/models/operations/get_sessions_response_body/go.mdx + - content/types/models/operations/get_sessions_response_body/python.mdx + - content/types/models/operations/get_sessions_response_body/typescript.mdx + - content/types/models/operations/get_sessions_stream/go.mdx + - content/types/models/operations/get_sessions_stream/python.mdx + - content/types/models/operations/get_sessions_stream/typescript.mdx - content/types/models/operations/get_source_connection_information_request/go.mdx - content/types/models/operations/get_source_connection_information_request/python.mdx - content/types/models/operations/get_source_connection_information_request/typescript.mdx @@ -1518,12 +1708,21 @@ generatedFiles: - content/types/models/operations/get_transient_token_response/go.mdx - content/types/models/operations/get_transient_token_response/python.mdx - content/types/models/operations/get_transient_token_response/typescript.mdx + - content/types/models/operations/get_update_status_media_container/go.mdx + - content/types/models/operations/get_update_status_media_container/python.mdx + - content/types/models/operations/get_update_status_media_container/typescript.mdx - content/types/models/operations/get_update_status_response/go.mdx - content/types/models/operations/get_update_status_response/python.mdx - content/types/models/operations/get_update_status_response/typescript.mdx + - content/types/models/operations/get_update_status_response_body/go.mdx + - content/types/models/operations/get_update_status_response_body/python.mdx + - content/types/models/operations/get_update_status_response_body/typescript.mdx - content/types/models/operations/guids/go.mdx - content/types/models/operations/guids/python.mdx - content/types/models/operations/guids/typescript.mdx + - content/types/models/operations/hub/go.mdx + - content/types/models/operations/hub/python.mdx + - content/types/models/operations/hub/typescript.mdx - content/types/models/operations/include_details/go.mdx - content/types/models/operations/include_details/python.mdx - content/types/models/operations/include_details/typescript.mdx @@ -1569,9 +1768,15 @@ generatedFiles: - content/types/models/operations/my_plex/go.mdx - content/types/models/operations/my_plex/python.mdx - content/types/models/operations/my_plex/typescript.mdx + - content/types/models/operations/one/go.mdx + - content/types/models/operations/one/python.mdx + - content/types/models/operations/one/typescript.mdx - content/types/models/operations/only_transient/go.mdx - content/types/models/operations/only_transient/python.mdx - content/types/models/operations/only_transient/typescript.mdx + - content/types/models/operations/operator/go.mdx + - content/types/models/operations/operator/python.mdx + - content/types/models/operations/operator/typescript.mdx - content/types/models/operations/part/go.mdx - content/types/models/operations/part/python.mdx - content/types/models/operations/part/typescript.mdx @@ -1590,9 +1795,15 @@ generatedFiles: - content/types/models/operations/perform_voice_search_response/go.mdx - content/types/models/operations/perform_voice_search_response/python.mdx - content/types/models/operations/perform_voice_search_response/typescript.mdx + - content/types/models/operations/player/go.mdx + - content/types/models/operations/player/python.mdx + - content/types/models/operations/player/typescript.mdx - content/types/models/operations/playlist_type/go.mdx - content/types/models/operations/playlist_type/python.mdx - content/types/models/operations/playlist_type/typescript.mdx + - content/types/models/operations/producer/go.mdx + - content/types/models/operations/producer/python.mdx + - content/types/models/operations/producer/typescript.mdx - content/types/models/operations/provider/go.mdx - content/types/models/operations/provider/python.mdx - content/types/models/operations/provider/typescript.mdx @@ -1605,15 +1816,18 @@ generatedFiles: - content/types/models/operations/query_param_type/go.mdx - content/types/models/operations/query_param_type/python.mdx - content/types/models/operations/query_param_type/typescript.mdx + - content/types/models/operations/ratings/go.mdx + - content/types/models/operations/ratings/python.mdx + - content/types/models/operations/ratings/typescript.mdx - content/types/models/operations/refresh_library_request/go.mdx - content/types/models/operations/refresh_library_request/python.mdx - content/types/models/operations/refresh_library_request/typescript.mdx - content/types/models/operations/refresh_library_response/go.mdx - content/types/models/operations/refresh_library_response/python.mdx - content/types/models/operations/refresh_library_response/typescript.mdx - - content/types/models/operations/response_body/go.mdx - - content/types/models/operations/response_body/python.mdx - - content/types/models/operations/response_body/typescript.mdx + - content/types/models/operations/release/go.mdx + - content/types/models/operations/release/python.mdx + - content/types/models/operations/release/typescript.mdx - content/types/models/operations/role/go.mdx - content/types/models/operations/role/python.mdx - content/types/models/operations/role/typescript.mdx @@ -1623,12 +1837,21 @@ generatedFiles: - content/types/models/operations/server/go.mdx - content/types/models/operations/server/python.mdx - content/types/models/operations/server/typescript.mdx + - content/types/models/operations/session/go.mdx + - content/types/models/operations/session/python.mdx + - content/types/models/operations/session/typescript.mdx + - content/types/models/operations/setting/go.mdx + - content/types/models/operations/setting/python.mdx + - content/types/models/operations/setting/typescript.mdx - content/types/models/operations/skip/go.mdx - content/types/models/operations/skip/python.mdx - content/types/models/operations/skip/typescript.mdx - content/types/models/operations/smart/go.mdx - content/types/models/operations/smart/python.mdx - content/types/models/operations/smart/typescript.mdx + - content/types/models/operations/sort/go.mdx + - content/types/models/operations/sort/python.mdx + - content/types/models/operations/sort/typescript.mdx - content/types/models/operations/start_all_tasks_response/go.mdx - content/types/models/operations/start_all_tasks_response/python.mdx - content/types/models/operations/start_all_tasks_response/typescript.mdx @@ -1665,6 +1888,9 @@ generatedFiles: - content/types/models/operations/stream/go.mdx - content/types/models/operations/stream/python.mdx - content/types/models/operations/stream/typescript.mdx + - content/types/models/operations/tag/go.mdx + - content/types/models/operations/tag/python.mdx + - content/types/models/operations/tag/typescript.mdx - content/types/models/operations/task_name/go.mdx - content/types/models/operations/task_name/python.mdx - content/types/models/operations/task_name/typescript.mdx @@ -1674,6 +1900,9 @@ generatedFiles: - content/types/models/operations/transcode_session/go.mdx - content/types/models/operations/transcode_session/python.mdx - content/types/models/operations/transcode_session/typescript.mdx + - content/types/models/operations/two/go.mdx + - content/types/models/operations/two/python.mdx + - content/types/models/operations/two/typescript.mdx - content/types/models/operations/type/go.mdx - content/types/models/operations/type/python.mdx - content/types/models/operations/type_t/typescript.mdx @@ -1698,6 +1927,9 @@ generatedFiles: - content/types/models/operations/upscale/go.mdx - content/types/models/operations/upscale/python.mdx - content/types/models/operations/upscale/typescript.mdx + - content/types/models/operations/user/go.mdx + - content/types/models/operations/user/python.mdx + - content/types/models/operations/user/typescript.mdx - content/types/models/operations/writer/go.mdx - content/types/models/operations/writer/python.mdx - content/types/models/operations/writer/typescript.mdx @@ -1724,23 +1956,17 @@ generatedFiles: - content/types/models/sdkerrors/get_available_clients_response_body/go.mdx - content/types/models/sdkerrors/get_butler_tasks_errors/go.mdx - content/types/models/sdkerrors/get_butler_tasks_response_body/go.mdx - - content/types/models/sdkerrors/get_common_library_items_errors/go.mdx - - content/types/models/sdkerrors/get_common_library_items_response_body/go.mdx - content/types/models/sdkerrors/get_devices_errors/go.mdx - content/types/models/sdkerrors/get_devices_response_body/go.mdx - content/types/models/sdkerrors/get_file_hash_errors/go.mdx - content/types/models/sdkerrors/get_file_hash_response_body/go.mdx - content/types/models/sdkerrors/get_global_hubs_errors/go.mdx - content/types/models/sdkerrors/get_global_hubs_response_body/go.mdx - - content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx - - content/types/models/sdkerrors/get_latest_library_items_response_body/go.mdx - content/types/models/sdkerrors/get_libraries_errors/go.mdx - content/types/models/sdkerrors/get_libraries_response_body/go.mdx - content/types/models/sdkerrors/get_library_errors/go.mdx - content/types/models/sdkerrors/get_library_hubs_errors/go.mdx - content/types/models/sdkerrors/get_library_hubs_response_body/go.mdx - - content/types/models/sdkerrors/get_library_items_errors/go.mdx - - content/types/models/sdkerrors/get_library_items_response_body/go.mdx - content/types/models/sdkerrors/get_library_response_body/go.mdx - content/types/models/sdkerrors/get_metadata_children_errors/go.mdx - content/types/models/sdkerrors/get_metadata_children_response_body/go.mdx @@ -2006,18 +2232,6 @@ generatedFiles: - content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx - content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx - content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx - - content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx - - content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx - content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx - content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx - content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx @@ -2187,13 +2401,18 @@ generatedFiles: - content/types/operations/get_server_capabilities_response_body/curl.mdx - content/types/operations/get_server_capabilities_response/curl.mdx - content/types/operations/get_server_preferences_errors/curl.mdx + - content/types/operations/get_server_preferences_server_response_body/curl.mdx + - content/types/operations/two/curl.mdx + - content/types/operations/one/curl.mdx + - content/types/operations/setting/curl.mdx + - content/types/operations/get_server_preferences_media_container/curl.mdx - content/types/operations/get_server_preferences_response_body/curl.mdx - content/types/operations/get_server_preferences_response/curl.mdx - content/types/operations/get_available_clients_errors/curl.mdx - - content/types/operations/get_available_clients_response_body/curl.mdx + - content/types/operations/get_available_clients_server_response_body/curl.mdx - content/types/operations/server/curl.mdx - content/types/operations/get_available_clients_media_container/curl.mdx - - content/types/operations/response_body/curl.mdx + - content/types/operations/get_available_clients_response_body/curl.mdx - content/types/operations/get_available_clients_response/curl.mdx - content/types/operations/get_devices_errors/curl.mdx - content/types/operations/get_devices_server_response_body/curl.mdx @@ -2271,11 +2490,26 @@ generatedFiles: - content/types/operations/only_transient/curl.mdx - content/types/operations/get_global_hubs_request/curl.mdx - content/types/operations/get_global_hubs_errors/curl.mdx + - content/types/operations/get_global_hubs_hubs_response_body/curl.mdx + - content/types/operations/get_global_hubs_metadata/curl.mdx + - content/types/operations/hub/curl.mdx + - content/types/operations/get_global_hubs_media_container/curl.mdx - content/types/operations/get_global_hubs_response_body/curl.mdx - content/types/operations/get_global_hubs_response/curl.mdx - content/types/operations/query_param_only_transient/curl.mdx - content/types/operations/get_library_hubs_request/curl.mdx - content/types/operations/get_library_hubs_errors/curl.mdx + - content/types/operations/get_library_hubs_hubs_response_body/curl.mdx + - content/types/operations/get_library_hubs_part/curl.mdx + - content/types/operations/get_library_hubs_media/curl.mdx + - content/types/operations/get_library_hubs_genre/curl.mdx + - content/types/operations/get_library_hubs_country/curl.mdx + - content/types/operations/get_library_hubs_director/curl.mdx + - content/types/operations/get_library_hubs_role/curl.mdx + - content/types/operations/get_library_hubs_writer/curl.mdx + - content/types/operations/get_library_hubs_metadata/curl.mdx + - content/types/operations/get_library_hubs_hub/curl.mdx + - content/types/operations/get_library_hubs_media_container/curl.mdx - content/types/operations/get_library_hubs_response_body/curl.mdx - content/types/operations/get_library_hubs_response/curl.mdx - content/types/operations/perform_search_request/curl.mdx @@ -2328,42 +2562,70 @@ generatedFiles: - content/types/operations/include_details/curl.mdx - content/types/operations/get_library_request/curl.mdx - content/types/operations/get_library_errors/curl.mdx + - content/types/operations/get_library_library_response_body/curl.mdx + - content/types/operations/get_library_directory/curl.mdx + - content/types/operations/filter/curl.mdx + - content/types/operations/sort/curl.mdx + - content/types/operations/field/curl.mdx + - content/types/operations/get_library_type/curl.mdx + - content/types/operations/operator/curl.mdx + - content/types/operations/field_type/curl.mdx + - content/types/operations/get_library_media_container/curl.mdx - content/types/operations/get_library_response_body/curl.mdx - content/types/operations/get_library_response/curl.mdx - content/types/operations/delete_library_request/curl.mdx - content/types/operations/delete_library_errors/curl.mdx - content/types/operations/delete_library_response_body/curl.mdx - content/types/operations/delete_library_response/curl.mdx + - content/types/operations/tag/curl.mdx - content/types/operations/get_library_items_request/curl.mdx - - content/types/operations/get_library_items_errors/curl.mdx + - content/types/operations/get_library_items_part/curl.mdx + - content/types/operations/get_library_items_media/curl.mdx + - content/types/operations/get_library_items_genre/curl.mdx + - content/types/operations/get_library_items_country/curl.mdx + - content/types/operations/get_library_items_director/curl.mdx + - content/types/operations/get_library_items_writer/curl.mdx + - content/types/operations/get_library_items_role/curl.mdx + - content/types/operations/get_library_items_metadata/curl.mdx + - content/types/operations/get_library_items_media_container/curl.mdx - content/types/operations/get_library_items_response_body/curl.mdx - content/types/operations/get_library_items_response/curl.mdx - content/types/operations/refresh_library_request/curl.mdx - content/types/operations/refresh_library_errors/curl.mdx - content/types/operations/refresh_library_response_body/curl.mdx - content/types/operations/refresh_library_response/curl.mdx - - content/types/operations/get_latest_library_items_request/curl.mdx - - content/types/operations/get_latest_library_items_errors/curl.mdx - - content/types/operations/get_latest_library_items_response_body/curl.mdx - - content/types/operations/get_latest_library_items_response/curl.mdx - - content/types/operations/get_common_library_items_request/curl.mdx - - content/types/operations/get_common_library_items_errors/curl.mdx - - content/types/operations/get_common_library_items_response_body/curl.mdx - - content/types/operations/get_common_library_items_response/curl.mdx - content/types/operations/get_metadata_request/curl.mdx - content/types/operations/get_metadata_errors/curl.mdx + - content/types/operations/get_metadata_library_response_body/curl.mdx + - content/types/operations/stream/curl.mdx + - content/types/operations/get_metadata_part/curl.mdx + - content/types/operations/get_metadata_media/curl.mdx + - content/types/operations/get_metadata_genre/curl.mdx + - content/types/operations/get_metadata_country/curl.mdx + - content/types/operations/guids/curl.mdx + - content/types/operations/ratings/curl.mdx + - content/types/operations/get_metadata_director/curl.mdx + - content/types/operations/get_metadata_writer/curl.mdx + - content/types/operations/get_metadata_role/curl.mdx + - content/types/operations/producer/curl.mdx + - content/types/operations/get_metadata_metadata/curl.mdx + - content/types/operations/get_metadata_media_container/curl.mdx - content/types/operations/get_metadata_response_body/curl.mdx - content/types/operations/get_metadata_response/curl.mdx - content/types/operations/get_metadata_children_request/curl.mdx - content/types/operations/get_metadata_children_errors/curl.mdx + - content/types/operations/get_metadata_children_library_response_body/curl.mdx + - content/types/operations/get_metadata_children_directory/curl.mdx + - content/types/operations/get_metadata_children_metadata/curl.mdx + - content/types/operations/get_metadata_children_media_container/curl.mdx - content/types/operations/get_metadata_children_response_body/curl.mdx - content/types/operations/get_metadata_children_response/curl.mdx - content/types/operations/get_on_deck_errors/curl.mdx - content/types/operations/get_on_deck_library_response_body/curl.mdx - - content/types/operations/stream/curl.mdx + - content/types/operations/get_on_deck_stream/curl.mdx - content/types/operations/get_on_deck_part/curl.mdx - content/types/operations/get_on_deck_media/curl.mdx - - content/types/operations/guids/curl.mdx + - content/types/operations/get_on_deck_guids/curl.mdx - content/types/operations/get_on_deck_metadata/curl.mdx - content/types/operations/get_on_deck_media_container/curl.mdx - content/types/operations/get_on_deck_response_body/curl.mdx @@ -2376,6 +2638,7 @@ generatedFiles: - content/types/operations/log_multi_line_errors/curl.mdx - content/types/operations/log_multi_line_response_body/curl.mdx - content/types/operations/log_multi_line_response/curl.mdx + - content/types/operations/log_multi_line_request_body/curl.mdx - content/types/operations/enable_paper_trail_errors/curl.mdx - content/types/operations/enable_paper_trail_response_body/curl.mdx - content/types/operations/enable_paper_trail_response/curl.mdx @@ -2383,16 +2646,25 @@ generatedFiles: - content/types/operations/smart/curl.mdx - content/types/operations/create_playlist_request/curl.mdx - content/types/operations/create_playlist_errors/curl.mdx + - content/types/operations/create_playlist_playlists_response_body/curl.mdx + - content/types/operations/create_playlist_metadata/curl.mdx + - content/types/operations/create_playlist_media_container/curl.mdx - content/types/operations/create_playlist_response_body/curl.mdx - content/types/operations/create_playlist_response/curl.mdx - content/types/operations/playlist_type/curl.mdx - content/types/operations/query_param_smart/curl.mdx - content/types/operations/get_playlists_request/curl.mdx - content/types/operations/get_playlists_errors/curl.mdx + - content/types/operations/get_playlists_playlists_response_body/curl.mdx + - content/types/operations/get_playlists_metadata/curl.mdx + - content/types/operations/get_playlists_media_container/curl.mdx - content/types/operations/get_playlists_response_body/curl.mdx - content/types/operations/get_playlists_response/curl.mdx - content/types/operations/get_playlist_request/curl.mdx - content/types/operations/get_playlist_errors/curl.mdx + - content/types/operations/get_playlist_playlists_response_body/curl.mdx + - content/types/operations/get_playlist_metadata/curl.mdx + - content/types/operations/get_playlist_media_container/curl.mdx - content/types/operations/get_playlist_response_body/curl.mdx - content/types/operations/get_playlist_response/curl.mdx - content/types/operations/delete_playlist_request/curl.mdx @@ -2405,6 +2677,16 @@ generatedFiles: - content/types/operations/update_playlist_response/curl.mdx - content/types/operations/get_playlist_contents_request/curl.mdx - content/types/operations/get_playlist_contents_errors/curl.mdx + - content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx + - content/types/operations/get_playlist_contents_part/curl.mdx + - content/types/operations/get_playlist_contents_media/curl.mdx + - content/types/operations/get_playlist_contents_genre/curl.mdx + - content/types/operations/get_playlist_contents_country/curl.mdx + - content/types/operations/get_playlist_contents_director/curl.mdx + - content/types/operations/get_playlist_contents_writer/curl.mdx + - content/types/operations/get_playlist_contents_role/curl.mdx + - content/types/operations/get_playlist_contents_metadata/curl.mdx + - content/types/operations/get_playlist_contents_media_container/curl.mdx - content/types/operations/get_playlist_contents_response_body/curl.mdx - content/types/operations/get_playlist_contents_response/curl.mdx - content/types/operations/clear_playlist_contents_request/curl.mdx @@ -2413,6 +2695,9 @@ generatedFiles: - content/types/operations/clear_playlist_contents_response/curl.mdx - content/types/operations/add_playlist_contents_request/curl.mdx - content/types/operations/add_playlist_contents_errors/curl.mdx + - content/types/operations/add_playlist_contents_playlists_response_body/curl.mdx + - content/types/operations/add_playlist_contents_metadata/curl.mdx + - content/types/operations/add_playlist_contents_media_container/curl.mdx - content/types/operations/add_playlist_contents_response_body/curl.mdx - content/types/operations/add_playlist_contents_response/curl.mdx - content/types/operations/force/curl.mdx @@ -2431,9 +2716,21 @@ generatedFiles: - content/types/operations/get_source_connection_information_response_body/curl.mdx - content/types/operations/get_source_connection_information_response/curl.mdx - content/types/operations/get_sessions_errors/curl.mdx + - content/types/operations/get_sessions_sessions_response_body/curl.mdx + - content/types/operations/get_sessions_stream/curl.mdx + - content/types/operations/get_sessions_part/curl.mdx + - content/types/operations/get_sessions_media/curl.mdx + - content/types/operations/user/curl.mdx + - content/types/operations/player/curl.mdx + - content/types/operations/session/curl.mdx + - content/types/operations/get_sessions_metadata/curl.mdx + - content/types/operations/get_sessions_media_container/curl.mdx - content/types/operations/get_sessions_response_body/curl.mdx - content/types/operations/get_sessions_response/curl.mdx - content/types/operations/get_session_history_errors/curl.mdx + - content/types/operations/get_session_history_sessions_response_body/curl.mdx + - content/types/operations/get_session_history_metadata/curl.mdx + - content/types/operations/get_session_history_media_container/curl.mdx - content/types/operations/get_session_history_response_body/curl.mdx - content/types/operations/get_session_history_response/curl.mdx - content/types/operations/get_transcode_sessions_errors/curl.mdx @@ -2447,6 +2744,9 @@ generatedFiles: - content/types/operations/stop_transcode_session_response_body/curl.mdx - content/types/operations/stop_transcode_session_response/curl.mdx - content/types/operations/get_update_status_errors/curl.mdx + - content/types/operations/get_update_status_updater_response_body/curl.mdx + - content/types/operations/release/curl.mdx + - content/types/operations/get_update_status_media_container/curl.mdx - content/types/operations/get_update_status_response_body/curl.mdx - content/types/operations/get_update_status_response/curl.mdx - content/types/operations/download/curl.mdx @@ -2664,24 +2964,12 @@ generatedFiles: - src/.gen/pages/01-reference/python/resources/library/delete_library/_usage.mdx - src/.gen/pages/01-reference/python/resources/library/delete_library/delete_library.mdx - src/.gen/pages/01-reference/python/resources/library/delete_library/delete_library_content.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx - - src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items_content.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/_header.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/_parameters.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/_response.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/_usage.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/get_file_hash.mdx - src/.gen/pages/01-reference/python/resources/library/get_file_hash/get_file_hash_content.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx - - src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items_content.mdx - src/.gen/pages/01-reference/python/resources/library/get_libraries/_header.mdx - src/.gen/pages/01-reference/python/resources/library/get_libraries/_parameters.mdx - src/.gen/pages/01-reference/python/resources/library/get_libraries/_response.mdx @@ -3139,24 +3427,12 @@ generatedFiles: - src/.gen/pages/01-reference/typescript/resources/library/delete_library/_usage.mdx - src/.gen/pages/01-reference/typescript/resources/library/delete_library/delete_library.mdx - src/.gen/pages/01-reference/typescript/resources/library/delete_library/delete_library_content.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items_content.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/_header.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/_parameters.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/_response.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/_usage.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/get_file_hash.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_file_hash/get_file_hash_content.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx - - src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items_content.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_libraries/_header.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_libraries/_parameters.mdx - src/.gen/pages/01-reference/typescript/resources/library/get_libraries/_response.mdx @@ -3614,24 +3890,12 @@ generatedFiles: - src/.gen/pages/01-reference/go/resources/library/delete_library/_usage.mdx - src/.gen/pages/01-reference/go/resources/library/delete_library/delete_library.mdx - src/.gen/pages/01-reference/go/resources/library/delete_library/delete_library_content.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx - - src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items_content.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/_header.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/_parameters.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/_response.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/_usage.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/get_file_hash.mdx - src/.gen/pages/01-reference/go/resources/library/get_file_hash/get_file_hash_content.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx - - src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items_content.mdx - src/.gen/pages/01-reference/go/resources/library/get_libraries/_header.mdx - src/.gen/pages/01-reference/go/resources/library/get_libraries/_parameters.mdx - src/.gen/pages/01-reference/go/resources/library/get_libraries/_response.mdx @@ -4090,13 +4354,6 @@ generatedFiles: - src/.gen/pages/01-reference/curl/resources/library/delete_library/_usage.mdx - src/.gen/pages/01-reference/curl/resources/library/delete_library/delete_library.mdx - src/.gen/pages/01-reference/curl/resources/library/delete_library/delete_library_content.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items_content.mdx - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_authentication.mdx - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_header.mdx - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_parameters.mdx @@ -4104,13 +4361,6 @@ generatedFiles: - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/get_file_hash.mdx - src/.gen/pages/01-reference/curl/resources/library/get_file_hash/get_file_hash_content.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx - - src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items_content.mdx - src/.gen/pages/01-reference/curl/resources/library/get_libraries/_authentication.mdx - src/.gen/pages/01-reference/curl/resources/library/get_libraries/_header.mdx - src/.gen/pages/01-reference/curl/resources/library/get_libraries/_parameters.mdx diff --git a/RELEASES.md b/RELEASES.md index c2f31bf..f1ea636 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -28,4 +28,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 0.0.3 -- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy + +## 2024-01-23 00:30:51 +### Changes +Based on: +- OpenAPI Doc 0.0.3 +- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx index b4d1b4e..4d3e5d6 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetGlobalHubsMediaContainer from "/content/types/operations/get_global_hubs_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx index 42ee115..81a1eef 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx @@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/hubs?count=567.13 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx index b4d1b4e..cc30f05 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryHubsMediaContainer from "/content/types/operations/get_library_hubs_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx index b72f0c7..62afa3f 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx @@ -9,13 +9,15 @@ curl http://10.10.10.47:32400/hubs/sections/9636.63?count=2726.56 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx deleted file mode 100644 index ac82b0b..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### API key _— in HTTP header_ - -Set your API key in a `X-Plex-Token` HTTP header. - -Example: `` - diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index 48d0dc6..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import OperationInfo from '/src/components/OperationInfo'; - -## Get Common Library Items - - - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter - diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index 3d2d98d..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 1990960..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,30 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} - -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; -import { TabbedSection, Tab } from '@/src/components/TabbedSection'; -import StatusCode from '@/src/components/StatusCode'; - - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - *JSON object* - - ##### `errors` _array (optional)_ - - - - - diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 1539dba..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,21 +0,0 @@ - - -```bash Example Request -curl http://10.10.10.47:32400/library/sections/8360.79/common?filter=string&type=710.36 \ ---header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx deleted file mode 100644 index ac82b0b..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### API key _— in HTTP header_ - -Set your API key in a `X-Plex-Token` HTTP header. - -Example: `` - diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index f3df705..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import OperationInfo from '/src/components/OperationInfo'; - -## Get Latest Library Items - - - -This endpoint will return a list of the latest library items filtered by the filter and type provided - diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index 3d2d98d..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index b4d1b4e..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} - -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; -import { TabbedSection, Tab } from '@/src/components/TabbedSection'; -import StatusCode from '@/src/components/StatusCode'; - - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - *JSON object* - - ##### `errors` _array (optional)_ - - - - - diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 3dbfef7..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,21 +0,0 @@ - - -```bash Example Request -curl http://10.10.10.47:32400/library/sections/3927.85/latest?filter=string&type=9255.97 \ ---header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_library/_header.mdx b/content/pages/01-reference/curl/resources/library/get_library/_header.mdx index 4361404..3ba4687 100644 --- a/content/pages/01-reference/curl/resources/library/get_library/_header.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library/_header.mdx @@ -4,23 +4,43 @@ import OperationInfo from '/src/components/OperationInfo'; -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/curl/resources/library/get_library/_response.mdx b/content/pages/01-reference/curl/resources/library/get_library/_response.mdx index b4d1b4e..a96c2cc 100644 --- a/content/pages/01-reference/curl/resources/library/get_library/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryMediaContainer from "/content/types/operations/get_library_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx index 8afc760..9678365 100644 --- a/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx @@ -9,13 +9,23 @@ curl http://10.10.10.47:32400/library/sections/1000 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx index bc8090d..5027190 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx @@ -2,7 +2,27 @@ import OperationInfo from '/src/components/OperationInfo'; ## Get Library Items - + -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx index 95cc82a..56fb06d 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx @@ -1,12 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ +import Tag from "/content/types/operations/tag/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ the Id of the library to query --- -##### `type` _number (optional)_ -item type +##### `tag` _enumeration_ +A key representing a specific tag within the section. ---- -##### `filter` _string (optional)_ -the filter parameter + + + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx index b4d1b4e..b2b7df3 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryItemsMediaContainer from "/content/types/operations/get_library_items_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,18 +9,13 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> *JSON object* - ##### `errors` _array (optional)_ - + ##### `MediaContainer` _object (optional)_ + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index 13d4929..cad2b5e 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/5288.95/all?filter=string&type=4799.77 \ +curl http://10.10.10.47:32400/library/sections/528895/{{tag}} \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,23 @@ curl http://10.10.10.47:32400/library/sections/5288.95/all?filter=string&type=47 ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx index b4d1b4e..3466082 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetMetadataMediaContainer from "/content/types/operations/get_metadata_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 93ed8b3..1992ca0 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/3373.96 \ +curl http://10.10.10.47:32400/library/metadata/5680.45 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,17 @@ curl http://10.10.10.47:32400/library/metadata/3373.96 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx index b4d1b4e..4bf1491 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetMetadataChildrenMediaContainer from "/content/types/operations/get_metadata_children_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 16cdd79..73dc215 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/871.29/children \ +curl http://10.10.10.47:32400/library/metadata/3927.85/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,31 @@ curl http://10.10.10.47:32400/library/metadata/871.29/children \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/library/library.mdx b/content/pages/01-reference/curl/resources/library/library.mdx index 3b5c394..dbc7380 100644 --- a/content/pages/01-reference/curl/resources/library/library.mdx +++ b/content/pages/01-reference/curl/resources/library/library.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/curl/library/delete_library) - Delete Library Section * [Get Library Items](/curl/library/get_library_items) - Get Library Items * [Refresh Library](/curl/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/curl/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/curl/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/curl/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children * [Get On Deck](/curl/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx index df64a68..c51d37a 100644 --- a/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/5680.45/refresh \ +curl http://10.10.10.47:32400/library/sections/4799.77/refresh \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx b/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx index b55b9a3..b6ecd5b 100644 --- a/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -19,8 +19,12 @@ An integer log level to write to the PMS log with. --- ##### `message` _string_ The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` _string_ a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx b/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx index 188f4d6..751fd6a 100644 --- a/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx +++ b/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/log?message=string&source=string \ +curl http://10.10.10.47:32400/log?message=Test%20log%20message&source=Postman \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx index 3a5596d..b528708 100644 --- a/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx @@ -4,5 +4,25 @@ import OperationInfo from '/src/components/OperationInfo'; -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx index 929b020..1e28503 100644 --- a/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx @@ -1,2 +1,9 @@ {/* Autogenerated DO NOT EDIT */} +import LogMultiLineRequestBody from "/content/types/operations/log_multi_line_request_body/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Request Body` __ + + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx index 1f25b87..38b0a04 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx @@ -4,6 +4,6 @@ import OperationInfo from '/src/components/OperationInfo'; -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx index fb33aec..96b7d29 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` _string_ the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID` _number_ +##### `playQueueID` _number (optional)_ the play queue to add to a playlist
**Example:** `123` diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx index b4d1b4e..30f49f8 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import AddPlaylistContentsMediaContainer from "/content/types/operations/add_playlist_contents_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index 46ef29a..c08b4a6 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8700.13/items?playQueueID=123&uri=library%3A%2F%2F.. \ +curl http://10.10.10.47:32400/playlists/3682.41/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/playlists/8700.13/items?playQueueID=123&uri=librar ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index 734c63b..fb23a7e 100644 --- a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/1403.5/items \ +curl http://10.10.10.47:32400/playlists/202.18/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx index 041613e..61c7063 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx @@ -5,6 +5,6 @@ import OperationInfo from '/src/components/OperationInfo'; Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx index 3988550..b6b73de 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx @@ -24,7 +24,7 @@ whether the playlist is smart or not --- -##### `uri` _string (optional)_ +##### `uri` _string_ the content URI for the playlist --- diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx index b4d1b4e..4572491 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import CreatePlaylistMediaContainer from "/content/types/operations/create_playlist_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 01b3a54..75d9c51 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=6481.72&title=string&uri=string \ +curl http://10.10.10.47:32400/playlists?playQueueID=9255.97&title=string&uri=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists?playQueueID=6481.72&title=string&uri=str ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 8678211..398e8d7 100644 --- a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3682.41 \ +curl http://10.10.10.47:32400/playlists/710.36 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx index b4d1b4e..51893dd 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistMediaContainer from "/content/types/operations/get_playlist_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index e4f1206..00e1dc3 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/202.18 \ +curl http://10.10.10.47:32400/playlists/8360.79 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists/202.18 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx index b4d1b4e..56e1182 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistContentsMediaContainer from "/content/types/operations/get_playlist_contents_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index 1d8a9b7..c827cad 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9571.56/items?type=7781.57 \ +curl http://10.10.10.47:32400/playlists/871.29/items?type=6481.72 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,17 @@ curl http://10.10.10.47:32400/playlists/9571.56/items?type=7781.57 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx index d2ebc33..9f5bd4b 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx @@ -2,6 +2,6 @@ import OperationInfo from '/src/components/OperationInfo'; ## Get Playlists - + Get All Playlists given the specified filters. diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx index b4d1b4e..e857ba6 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistsMediaContainer from "/content/types/operations/get_playlists_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx index dcbde8a..56a868b 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/all \ +curl http://10.10.10.47:32400/playlists \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists/all \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx index d416598..4d19f8b 100644 --- a/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx @@ -2,3 +2,11 @@ ##### `playlistID` _number_ the ID of the playlist +--- +##### `title` _string (optional)_ +name of the playlist + +--- +##### `summary` _string (optional)_ +summary description of the playlist + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index 7b9f1aa..32bc5cd 100644 --- a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8326.2 \ +curl http://10.10.10.47:32400/playlists/3373.96?summary=string&title=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx index aaf8bc0..6178e07 100644 --- a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` _enumeration_ -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/content/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx b/content/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx index b4d1b4e..1ca619b 100644 --- a/content/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx +++ b/content/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetAvailableClientsMediaContainer from "/content/types/operations/get_available_clients_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx b/content/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx index 994b300..11f35ff 100644 --- a/content/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx +++ b/content/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx @@ -8,27 +8,25 @@ curl http://10.10.10.47:32400/clients \ --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/content/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx b/content/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx index b4d1b4e..75e7d00 100644 --- a/content/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx +++ b/content/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetServerPreferencesMediaContainer from "/content/types/operations/get_server_preferences_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx b/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx index afef627..23931ef 100644 --- a/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx +++ b/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/:/prefs \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx b/content/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx index b4d1b4e..d0fd060 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetSessionHistoryMediaContainer from "/content/types/operations/get_session_history_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx b/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx index 536d74d..ad383cc 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/status/sessions/history/all \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx b/content/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx index b4d1b4e..6184ec0 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetSessionsMediaContainer from "/content/types/operations/get_sessions_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx b/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx index 192d04d..9488a0c 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/status/sessions \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx b/content/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx index a73d785..d6008bf 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx @@ -11,32 +11,7 @@ curl http://10.10.10.47:32400/transcode/sessions \ { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx b/content/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx index b4d1b4e..6a89487 100644 --- a/content/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx +++ b/content/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx @@ -7,7 +7,7 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} - }> + }> _No response body._ {/* prettier-ignore */} diff --git a/content/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx b/content/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx index b4d1b4e..979c811 100644 --- a/content/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx +++ b/content/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetUpdateStatusMediaContainer from "/content/types/operations/get_update_status_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/content/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx b/content/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx index e0e7b37..9a25836 100644 --- a/content/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx +++ b/content/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx @@ -9,13 +9,14 @@ curl http://10.10.10.47:32400/updater/status \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index 041f591..cefdf4e 100644 --- a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=string&duration=9446.69&hasMDE=1433.53&key=string&playBackTime=5218.48&playQueueItemID=7586.16&ratingKey=5820.2&row=1059.07&time=5373.73 \ +curl http://10.10.10.47:32400/:/timeline?context=string&duration=7206.33&hasMDE=6788.8&key=string&playBackTime=5820.2&playQueueItemID=6399.21&ratingKey=7805.29&row=1433.53&time=1182.74 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index cb9f677..5ac2ead 100644 --- a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=7206.33&audioBoost=6788.8&autoAdjustQuality=6399.21&directPlay=4614.79&directStream=5204.78&fastSeek=8009.11&hasMDE=9786.19&location=string&mediaBufferSize=1182.74&mediaIndex=4736.08&partIndex=7991.59&path=string&protocol=string&session=string&subtites=string&subtitleSize=7805.29 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4614.79&audioBoost=7991.59&autoAdjustQuality=5204.78&directPlay=8700.88&directStream=9786.19&fastSeek=8700.13&hasMDE=9571.56&location=string&mediaBufferSize=8009.11&mediaIndex=7781.57&partIndex=1403.5&path=string&protocol=string&session=string&subtites=string&subtitleSize=4736.08 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx index 63af3ce..5dc50d9 100644 --- a/content/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx +++ b/content/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,12 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx index b878c55..1e70b70 100644 --- a/content/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx +++ b/content/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -30,7 +29,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -39,13 +38,15 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx b/content/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/content/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/content/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx b/content/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index 3f642ed..0000000 --- a/content/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `sectionID` *{`float64`}* -the Id of the library to query - ---- -##### `type_` *{`float64`}* -item type - ---- -##### `filter` *{`*string`}* -the filter parameter - diff --git a/content/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx b/content/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 93f23a3..0000000 --- a/content/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetCommonLibraryItemsResponse`}* - - - - - - ---- -##### *{`error`}* - - diff --git a/content/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx b/content/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 574beb7..0000000 --- a/content/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - -```go GetCommonLibraryItems.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" - "net/http" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var sectionID float64 = 5288.95 - - var type_ float64 = 4799.77 - - var filter *string = "string" - - ctx := context.Background() - res, err := s.Library.GetCommonLibraryItems(ctx, sectionID, type_, filter) - if err != nil { - log.Fatal(err) - } - - if res.StatusCode == http.StatusOK { - // handle response - } -} -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx b/content/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx b/content/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/content/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/content/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx b/content/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index 3f642ed..0000000 --- a/content/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `sectionID` *{`float64`}* -the Id of the library to query - ---- -##### `type_` *{`float64`}* -item type - ---- -##### `filter` *{`*string`}* -the filter parameter - diff --git a/content/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx b/content/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index b2a3e30..0000000 --- a/content/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetLatestLibraryItemsResponse`}* - - - - - - ---- -##### *{`error`}* - - diff --git a/content/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx b/content/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 51edaa5..0000000 --- a/content/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - -```go GetLatestLibraryItems.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" - "net/http" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var sectionID float64 = 7917.25 - - var type_ float64 = 8121.69 - - var filter *string = "string" - - ctx := context.Background() - res, err := s.Library.GetLatestLibraryItems(ctx, sectionID, type_, filter) - if err != nil { - log.Fatal(err) - } - - if res.StatusCode == http.StatusOK { - // handle response - } -} -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx b/content/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/go/resources/library/get_library/_header.mdx b/content/pages/01-reference/go/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/content/pages/01-reference/go/resources/library/get_library/_header.mdx +++ b/content/pages/01-reference/go/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/go/resources/library/get_library/_usage.mdx b/content/pages/01-reference/go/resources/library/get_library/_usage.mdx index b10a988..e60d37c 100644 --- a/content/pages/01-reference/go/resources/library/get_library/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_library/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,23 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx index 9da6954..68b5816 100644 --- a/content/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx +++ b/content/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx @@ -1,16 +1,20 @@ {/* Autogenerated DO NOT EDIT */} +import Tag from "/content/types/models/operations/tag/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) The context to use for the request. --- -##### `sectionID` *{`float64`}* +##### `sectionID` *{`int64`}* the Id of the library to query --- -##### `type_` *{`*float64`}* -item type +##### `tag` *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter` *{`*string`}* -the filter parameter + + + diff --git a/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx index 94b40de..2d0f43a 100644 --- a/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx @@ -6,9 +6,9 @@ package main import( "github.com/LukeHagar/plexgo/models/components" "github.com/LukeHagar/plexgo" + "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -17,19 +17,17 @@ func main() { ) - var sectionID float64 = 2726.56 + var sectionID int64 = 272656 - var type_ *float64 = 3834.41 - - var filter *string = "string" + var tag operations.Tag = operations.TagEdition ctx := context.Background() - res, err := s.Library.GetLibraryItems(ctx, sectionID, type_, filter) + res, err := s.Library.GetLibraryItems(ctx, sectionID, tag) if err != nil { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -38,13 +36,23 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx index 68f66f8..ecc687b 100644 --- a/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -17,7 +16,7 @@ func main() { ) - var ratingKey float64 = 5680.45 + var ratingKey float64 = 7917.25 ctx := context.Background() res, err := s.Library.GetMetadata(ctx, ratingKey) @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,17 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx index 8bf8450..54d793a 100644 --- a/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -17,7 +16,7 @@ func main() { ) - var ratingKey float64 = 3927.85 + var ratingKey float64 = 8121.69 ctx := context.Background() res, err := s.Library.GetMetadataChildren(ctx, ratingKey) @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,31 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/library/library.mdx b/content/pages/01-reference/go/resources/library/library.mdx index 97e8d10..6fba642 100644 --- a/content/pages/01-reference/go/resources/library/library.mdx +++ b/content/pages/01-reference/go/resources/library/library.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/go/library/delete_library) - Delete Library Section * [Get Library Items](/go/library/get_library_items) - Get Library Items * [Refresh Library](/go/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/go/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/go/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/go/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children * [Get On Deck](/go/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/content/pages/01-reference/go/resources/log/log_line/_parameters.mdx b/content/pages/01-reference/go/resources/log/log_line/_parameters.mdx index 228c7a3..d5599b5 100644 --- a/content/pages/01-reference/go/resources/log/log_line/_parameters.mdx +++ b/content/pages/01-reference/go/resources/log/log_line/_parameters.mdx @@ -11,7 +11,7 @@ The context to use for the request. An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -23,8 +23,12 @@ An integer log level to write to the PMS log with. --- ##### `message` *{`string`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` *{`string`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/pages/01-reference/go/resources/log/log_line/_usage.mdx b/content/pages/01-reference/go/resources/log/log_line/_usage.mdx index 07d1611..438c6ca 100644 --- a/content/pages/01-reference/go/resources/log/log_line/_usage.mdx +++ b/content/pages/01-reference/go/resources/log/log_line/_usage.mdx @@ -18,11 +18,11 @@ func main() { ) - var level operations.Level = operations.LevelFour + var level operations.Level = operations.LevelTwo - var message string = "string" + var message string = "Test log message" - var source string = "string" + var source string = "Postman" ctx := context.Background() res, err := s.Log.LogLine(ctx, level, message, source) diff --git a/content/pages/01-reference/go/resources/log/log_multi_line/_header.mdx b/content/pages/01-reference/go/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/content/pages/01-reference/go/resources/log/log_multi_line/_header.mdx +++ b/content/pages/01-reference/go/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/content/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx b/content/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx index 186de0c..4f061b2 100644 --- a/content/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx +++ b/content/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx @@ -2,3 +2,7 @@ ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) The context to use for the request. +--- +##### `request` *{`string`}* +The request object to use for the request. + diff --git a/content/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx b/content/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx index b34e41d..a447756 100644 --- a/content/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx +++ b/content/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx @@ -17,7 +17,9 @@ func main() { ) ctx := context.Background() - res, err := s.Log.LogMultiLine(ctx) + res, err := s.Log.LogMultiLine(ctx, "level=4&message=Test%20message%201&source=postman +level=3&message=Test%20message%202&source=postman +level=1&message=Test%20message%203&source=postman") if err != nil { log.Fatal(err) } diff --git a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx +++ b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx index 94ed5d5..c010450 100644 --- a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx @@ -10,10 +10,10 @@ the ID of the playlist ##### `uri` *{`string`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID` *{`float64`}* +##### `playQueueID` *{`*float64`}* the play queue to add to a playlist
**Example:** `123` diff --git a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx index 15e6c92..eef517a 100644 --- a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -19,9 +18,9 @@ func main() { var playlistID float64 = 1403.5 - var uri string = "library://.." + var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1" - var playQueueID float64 = 123 + var playQueueID *float64 = 123 ctx := context.Background() res, err := s.Playlists.AddPlaylistContents(ctx, playlistID, uri, playQueueID) @@ -29,7 +28,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -38,13 +37,12 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx b/content/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/content/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx +++ b/content/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx index 22d1428..4e21e98 100644 --- a/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx @@ -9,7 +9,6 @@ import( "context" "github.com/LukeHagar/plexgo/models/operations" "log" - "net/http" ) func main() { @@ -20,14 +19,15 @@ func main() { ctx := context.Background() res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{ Title: "string", - Type: operations.TypePhoto, - Smart: operations.SmartZero, + Type: operations.TypeVideo, + Smart: operations.SmartOne, + URI: "http://velvety-spiderling.com", }) if err != nil { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -36,13 +36,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx index 440d6b8..efe3b2f 100644 --- a/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx index 5e76182..e537c19 100644 --- a/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -27,7 +26,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -36,13 +35,17 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx index 0e8055c..5b46ce3 100644 --- a/content/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx b/content/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx index 99bccc8..7675191 100644 --- a/content/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx +++ b/content/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx @@ -6,3 +6,11 @@ The context to use for the request. ##### `playlistID` *{`float64`}* the ID of the playlist +--- +##### `title` *{`*string`}* +name of the playlist + +--- +##### `summary` *{`*string`}* +summary description of the playlist + diff --git a/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx index f3ba6ff..e85835a 100644 --- a/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx @@ -19,8 +19,12 @@ func main() { var playlistID float64 = 3682.41 + var title *string = "string" + + var summary *string = "string" + ctx := context.Background() - res, err := s.Playlists.UpdatePlaylist(ctx, playlistID) + res, err := s.Playlists.UpdatePlaylist(ctx, playlistID, title, summary) if err != nil { log.Fatal(err) } diff --git a/content/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx b/content/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx index 10a2258..eb6572c 100644 --- a/content/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx +++ b/content/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx @@ -20,8 +20,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/content/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx b/content/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx index cd89fed..4ba090a 100644 --- a/content/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx +++ b/content/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx @@ -21,7 +21,7 @@ func main() { log.Fatal(err) } - if res.Classes != nil { + if res.Object != nil { // handle response } } @@ -29,27 +29,25 @@ func main() { --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/content/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx b/content/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx index fc17139..9765146 100644 --- a/content/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx +++ b/content/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx b/content/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx index 944c0f4..191fbd7 100644 --- a/content/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx +++ b/content/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx b/content/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx index d610282..b86b3ef 100644 --- a/content/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx +++ b/content/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx b/content/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx index eded734..00ca871 100644 --- a/content/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/content/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx @@ -32,32 +32,7 @@ func main() { { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/content/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx b/content/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx index b076862..34963ab 100644 --- a/content/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx +++ b/content/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,14 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx index f5847fa..ba11801 100644 --- a/content/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx +++ b/content/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.hubs.get_global_hubs(count=8472.52, only_transient=operations.OnlyTransient.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,12 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx index e322510..3064467 100644 --- a/content/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx +++ b/content/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.hubs.get_library_hubs(section_id=6235.64, count=6458.94, only_transient=operations.QueryParamOnlyTransient.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,15 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx b/content/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/content/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/content/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx b/content/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index c16bb37..0000000 --- a/content/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - diff --git a/content/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx b/content/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 5e40acb..0000000 --- a/content/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetCommonLibraryItemsResponse`}* - - - - - - - diff --git a/content/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx b/content/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 10a1254..0000000 --- a/content/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - -```python GetCommonLibraryItems.py -import plex_api -from plex_api.models import operations - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.library.get_common_library_items(section_id=5288.95, type=4799.77, filter_='string') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx b/content/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx b/content/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/content/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/content/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx b/content/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index c16bb37..0000000 --- a/content/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - diff --git a/content/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx b/content/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index 2ed87f8..0000000 --- a/content/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetLatestLibraryItemsResponse`}* - - - - - - - diff --git a/content/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx b/content/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index ab20568..0000000 --- a/content/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - -```python GetLatestLibraryItems.py -import plex_api -from plex_api.models import operations - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.library.get_latest_library_items(section_id=7917.25, type=8121.69, filter_='string') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx b/content/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/python/resources/library/get_library/_header.mdx b/content/pages/01-reference/python/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/content/pages/01-reference/python/resources/library/get_library/_header.mdx +++ b/content/pages/01-reference/python/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/python/resources/library/get_library/_usage.mdx b/content/pages/01-reference/python/resources/library/get_library/_usage.mdx index 20a4a35..9c9cd38 100644 --- a/content/pages/01-reference/python/resources/library/get_library/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_library/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ONE) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,23 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx index c7573a5..65a4873 100644 --- a/content/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx +++ b/content/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx @@ -1,12 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* +import Tag from "/content/types/models/operations/tag/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* the Id of the library to query --- -##### `type` *{`Optional[float]`}* -item type +##### `tag` *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter + + + diff --git a/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx index aacad90..923bcd0 100644 --- a/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_library_items(section_id=2726.56, type=3834.41, filter_='string') +res = s.library.get_library_items(section_id=272656, tag=operations.Tag.EDITION) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,23 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx index 443c483..c76aad7 100644 --- a/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata(rating_key=5680.45) +res = s.library.get_metadata(rating_key=7917.25) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,17 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx index 62fe4f6..1433ae8 100644 --- a/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata_children(rating_key=3927.85) +res = s.library.get_metadata_children(rating_key=8121.69) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,31 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/library/library.mdx b/content/pages/01-reference/python/resources/library/library.mdx index eb97081..e5ecced 100644 --- a/content/pages/01-reference/python/resources/library/library.mdx +++ b/content/pages/01-reference/python/resources/library/library.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/python/library/delete_library) - Delete Library Section * [Get Library Items](/python/library/get_library_items) - Get Library Items * [Refresh Library](/python/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/python/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/python/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/python/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children * [Get On Deck](/python/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/content/pages/01-reference/python/resources/log/log_line/_parameters.mdx b/content/pages/01-reference/python/resources/log/log_line/_parameters.mdx index 4effeb2..3cb00ec 100644 --- a/content/pages/01-reference/python/resources/log/log_line/_parameters.mdx +++ b/content/pages/01-reference/python/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -19,8 +19,12 @@ An integer log level to write to the PMS log with. --- ##### `message` *{`str`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` *{`str`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/pages/01-reference/python/resources/log/log_line/_usage.mdx b/content/pages/01-reference/python/resources/log/log_line/_usage.mdx index 96ea29a..f79e863 100644 --- a/content/pages/01-reference/python/resources/log/log_line/_usage.mdx +++ b/content/pages/01-reference/python/resources/log/log_line/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.log.log_line(level=operations.Level.FOUR, message='string', source='string') +res = s.log.log_line(level=operations.Level.TWO, message='Test log message', source='Postman') if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/log/log_multi_line/_header.mdx b/content/pages/01-reference/python/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/content/pages/01-reference/python/resources/log/log_multi_line/_header.mdx +++ b/content/pages/01-reference/python/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/content/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx b/content/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx index 929b020..5cbf752 100644 --- a/content/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx +++ b/content/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx @@ -1,2 +1,4 @@ {/* Autogenerated DO NOT EDIT */} +##### `request` *{`str`}* +The request object to use for the request. diff --git a/content/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx b/content/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx index abc5226..5b68810 100644 --- a/content/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx +++ b/content/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx @@ -7,8 +7,11 @@ s = plex_api.PlexAPI( access_token="", ) +req = 'level=4&message=Test%20message%201&source=postman +level=3&message=Test%20message%202&source=postman +level=1&message=Test%20message%203&source=postman' -res = s.log.log_multi_line() +res = s.log.log_multi_line(req) if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx +++ b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx index f23a7d6..91562a8 100644 --- a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` *{`str`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `play_queue_id` *{`float`}* +##### `play_queue_id` *{`Optional[float]`}* the play queue to add to a playlist
**Example:** `123` diff --git a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx index 4fd6429..3946ae0 100644 --- a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='library://..', play_queue_id=123) +res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,12 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx b/content/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/content/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx +++ b/content/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx index 0a04198..7145344 100644 --- a/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx @@ -10,13 +10,14 @@ s = plex_api.PlexAPI( req = operations.CreatePlaylistRequest( title='string', - type=operations.Type.PHOTO, - smart=operations.Smart.ZERO, + type=operations.Type.VIDEO, + smart=operations.Smart.ONE, + uri='http://velvety-spiderling.com', ) res = s.playlists.create_playlist(req) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -24,13 +25,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx index 41af0f3..cf53d74 100644 --- a/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlist(playlist_id=6481.72) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx index 8b7bbc3..b8c549b 100644 --- a/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,17 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx index d913ed6..1ba6a7b 100644 --- a/content/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlists(playlist_type=operations.PlaylistType.VIDEO, smart=operations.QueryParamSmart.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx b/content/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx index 0d41902..148f489 100644 --- a/content/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx +++ b/content/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx @@ -2,3 +2,11 @@ ##### `playlist_id` *{`float`}* the ID of the playlist +--- +##### `title` *{`Optional[str]`}* +name of the playlist + +--- +##### `summary` *{`Optional[str]`}* +summary description of the playlist + diff --git a/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx index 80106f3..33b1607 100644 --- a/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.update_playlist(playlist_id=3682.41) +res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string') if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx b/content/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx index c9f9981..f44f422 100644 --- a/content/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx +++ b/content/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/content/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx b/content/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx index 57c0800..8954af9 100644 --- a/content/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx +++ b/content/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx @@ -10,34 +10,32 @@ s = plex_api.PlexAPI( res = s.server.get_available_clients() -if res.classes is not None: +if res.object is not None: # handle response pass ``` --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/content/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx b/content/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx index 873cb31..1620c7a 100644 --- a/content/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx +++ b/content/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.server.get_server_preferences() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx b/content/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx index f92dcc5..a9917cf 100644 --- a/content/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx +++ b/content/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.sessions.get_session_history() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx b/content/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx index e7eeaa6..b4a4e31 100644 --- a/content/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx +++ b/content/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.sessions.get_sessions() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx b/content/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx index e3afa87..1eb9415 100644 --- a/content/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/content/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx @@ -20,32 +20,7 @@ if res.object is not None: { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/content/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx b/content/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx index 0ff1f3b..d03930e 100644 --- a/content/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx +++ b/content/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.updater.get_update_status() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,14 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx index 7412ed5..f78c603 100644 --- a/content/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx @@ -24,13 +24,12 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx index 29c9858..875f903 100644 --- a/content/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx @@ -25,13 +25,15 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx b/content/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx b/content/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index bc6ac2b..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,20 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - diff --git a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx b/content/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 3876875..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 57e7ece..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - -```typescript GetCommonLibraryItems.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const sectionId = 5288.95; - const type = 4799.77; - const filter = "string"; - - const result = await sdk.library.getCommonLibraryItems(sectionId, type, filter); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx b/content/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx b/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx b/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index bc6ac2b..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,20 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - diff --git a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx b/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index 3e5ce52..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 1637805..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - -```typescript GetLatestLibraryItems.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const sectionId = 7917.25; - const type = 8121.69; - const filter = "string"; - - const result = await sdk.library.getLatestLibraryItems(sectionId, type, filter); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx b/content/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index 4b79f78..0000000 --- a/content/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/library/get_library/_header.mdx b/content/pages/01-reference/typescript/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library/_header.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/typescript/resources/library/get_library/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_library/_usage.mdx index 728a85d..2c40f79 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library/_usage.mdx @@ -24,13 +24,23 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx index e8e7ff8..4197fac 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx @@ -1,14 +1,18 @@ {/* Autogenerated DO NOT EDIT */} +import Tag from "/content/types/models/operations/tag/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `sectionId`: *{`number`}* the Id of the library to query --- -##### `type?`: *{`number`}* -item type +##### `tag`: *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter?`: *{`string`}* -the filter parameter + + + --- ##### `options?`: *{`RequestOptions`}* diff --git a/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx index 90eb6a3..66dea81 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx @@ -2,17 +2,17 @@ ```typescript GetLibraryItems.ts import { PlexAPI } from "@lukehagar/plexjs"; +import { Tag } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ accessToken: "", }); - const sectionId = 2726.56; - const type = 3834.41; - const filter = "string"; + const sectionId = 272656; + const tag = Tag.Edition; - const result = await sdk.library.getLibraryItems(sectionId, type, filter); + const result = await sdk.library.getLibraryItems(sectionId, tag); // Handle the result console.log(result) @@ -24,13 +24,23 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx index 411badf..7b72a58 100644 --- a/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 5680.45; + const ratingKey = 7917.25; const result = await sdk.library.getMetadata(ratingKey); @@ -22,13 +22,17 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx index 1edcaf2..5a38d26 100644 --- a/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 3927.85; + const ratingKey = 8121.69; const result = await sdk.library.getMetadataChildren(ratingKey); @@ -22,13 +22,31 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/library/library.mdx b/content/pages/01-reference/typescript/resources/library/library.mdx index 53d837f..47efd43 100644 --- a/content/pages/01-reference/typescript/resources/library/library.mdx +++ b/content/pages/01-reference/typescript/resources/library/library.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/typescript/library/delete_library) - Delete Library Section * [Get Library Items](/typescript/library/get_library_items) - Get Library Items * [Refresh Library](/typescript/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/typescript/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/typescript/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/typescript/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/typescript/library/get_metadata_children) - Get Items Children * [Get On Deck](/typescript/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/content/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx b/content/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx index f62878c..5f6f942 100644 --- a/content/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose diff --git a/content/pages/01-reference/typescript/resources/log/log_line/_usage.mdx b/content/pages/01-reference/typescript/resources/log/log_line/_usage.mdx index c28b7a8..fa19a5e 100644 --- a/content/pages/01-reference/typescript/resources/log/log_line/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/log/log_line/_usage.mdx @@ -9,9 +9,9 @@ async function run() { accessToken: "", }); - const level = Level.Four; - const message = "string"; - const source = "string"; + const level = Level.Two; + const message = "Test log message"; + const source = "Postman"; const result = await sdk.log.logLine(level, message, source); diff --git a/content/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx b/content/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/content/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx +++ b/content/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/content/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx b/content/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx index d541e77..c503f99 100644 --- a/content/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx @@ -1,4 +1,8 @@ {/* Autogenerated DO NOT EDIT */} +##### `request`: *{`string`}* +The request object to use for the request. + +--- ##### `options?`: *{`RequestOptions`}* Options for making HTTP requests. diff --git a/content/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx b/content/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx index 624e7d0..45a0066 100644 --- a/content/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx @@ -8,7 +8,9 @@ async function run() { accessToken: "", }); - const result = await sdk.log.logMultiLine(); + const result = await sdk.log.logMultiLine("level=4&message=Test%20message%201&source=postman + level=3&message=Test%20message%202&source=postman + level=1&message=Test%20message%203&source=postman"); // Handle the result console.log(result) diff --git a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx index ed9d0b2..de1686c 100644 --- a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx @@ -9,7 +9,7 @@ the content URI for the playlist **Example:** `[object Object]` --- -##### `playQueueID`: *{`number`}* +##### `playQueueID?`: *{`number`}* the play queue to add to a playlist
**Example:** `[object Object]` diff --git a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx index a42ac92..03a7b53 100644 --- a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ async function run() { }); const playlistID = 1403.5; - const uri = "library://.."; + const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1"; const playQueueID = 123; const result = await sdk.playlists.addPlaylistContents(playlistID, uri, playQueueID); @@ -24,13 +24,12 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx index 75a183d..5e59556 100644 --- a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx @@ -11,8 +11,9 @@ async function run() { const result = await sdk.playlists.createPlaylist({ title: "string", - type: TypeT.Photo, - smart: Smart.Zero, + type: TypeT.Video, + smart: Smart.One, + uri: "http://velvety-spiderling.com", }); // Handle the result @@ -25,13 +26,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx index b5d0253..c9d23cb 100644 --- a/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx @@ -22,13 +22,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx index 14d7199..217e38b 100644 --- a/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx @@ -23,13 +23,17 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx index a01cf63..979b839 100644 --- a/content/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx @@ -24,13 +24,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx index 867032a..bafeab3 100644 --- a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx @@ -2,6 +2,14 @@ ##### `playlistID`: *{`number`}* the ID of the playlist +--- +##### `title?`: *{`string`}* +name of the playlist + +--- +##### `summary?`: *{`string`}* +summary description of the playlist + --- ##### `options?`: *{`RequestOptions`}* Options for making HTTP requests. diff --git a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx index e358c01..9bcfad4 100644 --- a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx @@ -9,8 +9,10 @@ async function run() { }); const playlistID = 3682.41; + const title = "string"; + const summary = "string"; - const result = await sdk.playlists.updatePlaylist(playlistID); + const result = await sdk.playlists.updatePlaylist(playlistID, title, summary); // Handle the result console.log(result) diff --git a/content/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx b/content/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx index 9a6b512..a115fd8 100644 --- a/content/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force`: *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/content/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx b/content/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx index 96de98e..6b42615 100644 --- a/content/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx @@ -19,27 +19,25 @@ run(); --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/content/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx b/content/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx index d82abc7..53975b2 100644 --- a/content/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx b/content/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx index 75a30c1..d13c6a6 100644 --- a/content/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx b/content/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx index dd7adeb..b87deec 100644 --- a/content/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/content/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx b/content/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx index 3d47287..180151f 100644 --- a/content/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx @@ -22,32 +22,7 @@ run(); { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/content/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx b/content/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx index 5c98d8d..946b3d2 100644 --- a/content/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx @@ -20,13 +20,14 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/content/types/models/errors/get_common_library_items_errors/python.mdx b/content/types/models/errors/get_common_library_items_errors/python.mdx deleted file mode 100644 index 8189f56..0000000 --- a/content/types/models/errors/get_common_library_items_errors/python.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` *{`Optional[float]`}* -
-**Example:** `1001` - ---- -##### `message` *{`Optional[str]`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status` *{`Optional[float]`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_common_library_items_errors/typescript.mdx b/content/types/models/errors/get_common_library_items_errors/typescript.mdx deleted file mode 100644 index 9ed36a5..0000000 --- a/content/types/models/errors/get_common_library_items_errors/typescript.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code?`: *{`number`}* -
-**Example:** `1001` - ---- -##### `message?`: *{`string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status?`: *{`number`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_common_library_items_response_body/python.mdx b/content/types/models/errors/get_common_library_items_response_body/python.mdx deleted file mode 100644 index 3aaef19..0000000 --- a/content/types/models/errors/get_common_library_items_response_body/python.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors` *{`List[errors.GetCommonLibraryItemsErrors]`}* - - import('/content/types/models/errors/get_common_library_items_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/get_common_library_items_response_body/typescript.mdx b/content/types/models/errors/get_common_library_items_response_body/typescript.mdx deleted file mode 100644 index d3d202e..0000000 --- a/content/types/models/errors/get_common_library_items_response_body/typescript.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors?`: *{`errors.GetCommonLibraryItemsErrors[]`}* - - import('/content/types/models/errors/get_common_library_items_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/get_latest_library_items_errors/python.mdx b/content/types/models/errors/get_latest_library_items_errors/python.mdx deleted file mode 100644 index 8189f56..0000000 --- a/content/types/models/errors/get_latest_library_items_errors/python.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` *{`Optional[float]`}* -
-**Example:** `1001` - ---- -##### `message` *{`Optional[str]`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status` *{`Optional[float]`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_latest_library_items_errors/typescript.mdx b/content/types/models/errors/get_latest_library_items_errors/typescript.mdx deleted file mode 100644 index 9ed36a5..0000000 --- a/content/types/models/errors/get_latest_library_items_errors/typescript.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code?`: *{`number`}* -
-**Example:** `1001` - ---- -##### `message?`: *{`string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status?`: *{`number`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_latest_library_items_response_body/python.mdx b/content/types/models/errors/get_latest_library_items_response_body/python.mdx deleted file mode 100644 index 81c357c..0000000 --- a/content/types/models/errors/get_latest_library_items_response_body/python.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors` *{`List[errors.GetLatestLibraryItemsErrors]`}* - - import('/content/types/models/errors/get_latest_library_items_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/get_latest_library_items_response_body/typescript.mdx b/content/types/models/errors/get_latest_library_items_response_body/typescript.mdx deleted file mode 100644 index 3816ae4..0000000 --- a/content/types/models/errors/get_latest_library_items_response_body/typescript.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors?`: *{`errors.GetLatestLibraryItemsErrors[]`}* - - import('/content/types/models/errors/get_latest_library_items_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/get_library_items_errors/python.mdx b/content/types/models/errors/get_library_items_errors/python.mdx deleted file mode 100644 index 8189f56..0000000 --- a/content/types/models/errors/get_library_items_errors/python.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` *{`Optional[float]`}* -
-**Example:** `1001` - ---- -##### `message` *{`Optional[str]`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status` *{`Optional[float]`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_library_items_errors/typescript.mdx b/content/types/models/errors/get_library_items_errors/typescript.mdx deleted file mode 100644 index 9ed36a5..0000000 --- a/content/types/models/errors/get_library_items_errors/typescript.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code?`: *{`number`}* -
-**Example:** `1001` - ---- -##### `message?`: *{`string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `status?`: *{`number`}* -
-**Example:** `401` - - diff --git a/content/types/models/errors/get_library_items_response_body/python.mdx b/content/types/models/errors/get_library_items_response_body/python.mdx deleted file mode 100644 index ff5ad29..0000000 --- a/content/types/models/errors/get_library_items_response_body/python.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors` *{`List[errors.GetLibraryItemsErrors]`}* - - import('/content/types/models/errors/get_library_items_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/get_library_items_response_body/typescript.mdx b/content/types/models/errors/get_library_items_response_body/typescript.mdx deleted file mode 100644 index bbbe718..0000000 --- a/content/types/models/errors/get_library_items_response_body/typescript.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors?`: *{`errors.GetLibraryItemsErrors[]`}* - - import('/content/types/models/errors/get_library_items_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/add_playlist_contents_media_container/go.mdx b/content/types/models/operations/add_playlist_contents_media_container/go.mdx new file mode 100644 index 0000000..d892975 --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_media_container/go.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `1` + +--- +##### `LeafCountAdded` *{`*int`}* +
+**Example:** `1` + +--- +##### `LeafCountRequested` *{`*int`}* +
+**Example:** `1` + +--- +##### `Metadata` *{`[]operations.AddPlaylistContentsMetadata`}* +
+**Example:** `[{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}]` + + import('/content/types/models/operations/add_playlist_contents_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/add_playlist_contents_media_container/python.mdx b/content/types/models/operations/add_playlist_contents_media_container/python.mdx new file mode 100644 index 0000000..b9ed3a1 --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_media_container/python.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `leaf_count_added` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `leaf_count_requested` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `metadata` *{`List[operations.AddPlaylistContentsMetadata]`}* +
+**Example:** `[{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}]` + + import('/content/types/models/operations/add_playlist_contents_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/add_playlist_contents_media_container/typescript.mdx b/content/types/models/operations/add_playlist_contents_media_container/typescript.mdx new file mode 100644 index 0000000..ce6852b --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_media_container/typescript.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `1` + +--- +##### `leafCountAdded?`: *{`number`}* +
+**Example:** `1` + +--- +##### `leafCountRequested?`: *{`number`}* +
+**Example:** `1` + +--- +##### `metadata?`: *{`operations.AddPlaylistContentsMetadata[]`}* +
+**Example:** `[{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}]` + + import('/content/types/models/operations/add_playlist_contents_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/add_playlist_contents_metadata/go.mdx b/content/types/models/operations/add_playlist_contents_metadata/go.mdx new file mode 100644 index 0000000..919dc2d --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_metadata/go.mdx @@ -0,0 +1,66 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `94` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/94/items` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `Title` *{`*string`}* +
+**Example:** `A great playlist` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `One of my great playlists` + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `false` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/94/composite/1705800070` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `423000` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `3` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705716458` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705800070` + + diff --git a/content/types/models/operations/add_playlist_contents_metadata/python.mdx b/content/types/models/operations/add_playlist_contents_metadata/python.mdx new file mode 100644 index 0000000..a56aa6a --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_metadata/python.mdx @@ -0,0 +1,66 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `94` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/94/items` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `A great playlist` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `One of my great playlists` + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/94/composite/1705800070` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `423000` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `3` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705716458` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705800070` + + diff --git a/content/types/models/operations/add_playlist_contents_metadata/typescript.mdx b/content/types/models/operations/add_playlist_contents_metadata/typescript.mdx new file mode 100644 index 0000000..676eb98 --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_metadata/typescript.mdx @@ -0,0 +1,66 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `94` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/94/items` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `title?`: *{`string`}* +
+**Example:** `A great playlist` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `One of my great playlists` + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/94/composite/1705800070` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `423000` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `3` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705716458` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705800070` + + diff --git a/content/types/models/operations/add_playlist_contents_request/go.mdx b/content/types/models/operations/add_playlist_contents_request/go.mdx index 96f9fa4..280db00 100644 --- a/content/types/models/operations/add_playlist_contents_request/go.mdx +++ b/content/types/models/operations/add_playlist_contents_request/go.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `URI` *{`string`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `PlayQueueID` *{`float64`}* +##### `PlayQueueID` *{`*float64`}* the play queue to add to a playlist
**Example:** `123` diff --git a/content/types/models/operations/add_playlist_contents_request/python.mdx b/content/types/models/operations/add_playlist_contents_request/python.mdx index 19fea9d..29fe98f 100644 --- a/content/types/models/operations/add_playlist_contents_request/python.mdx +++ b/content/types/models/operations/add_playlist_contents_request/python.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` *{`str`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `play_queue_id` *{`float`}* +##### `play_queue_id` *{`Optional[float]`}* the play queue to add to a playlist
**Example:** `123` diff --git a/content/types/models/operations/add_playlist_contents_request/typescript.mdx b/content/types/models/operations/add_playlist_contents_request/typescript.mdx index 9ee71be..12bfc08 100644 --- a/content/types/models/operations/add_playlist_contents_request/typescript.mdx +++ b/content/types/models/operations/add_playlist_contents_request/typescript.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri`: *{`string`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID`: *{`number`}* +##### `playQueueID?`: *{`number`}* the play queue to add to a playlist
**Example:** `123` diff --git a/content/types/models/operations/add_playlist_contents_response/go.mdx b/content/types/models/operations/add_playlist_contents_response/go.mdx index 3b4ae5c..94d56b7 100644 --- a/content/types/models/operations/add_playlist_contents_response/go.mdx +++ b/content/types/models/operations/add_playlist_contents_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.AddPlaylistContentsResponseBody`}* +Playlist Updated + + import('/content/types/models/operations/add_playlist_contents_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/add_playlist_contents_response/python.mdx b/content/types/models/operations/add_playlist_contents_response/python.mdx index 93ee0a0..d0cff22 100644 --- a/content/types/models/operations/add_playlist_contents_response/python.mdx +++ b/content/types/models/operations/add_playlist_contents_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.AddPlaylistContentsResponseBody]`}* +Playlist Updated + + import('/content/types/models/operations/add_playlist_contents_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/add_playlist_contents_response/typescript.mdx b/content/types/models/operations/add_playlist_contents_response/typescript.mdx index 2035a36..0a891a4 100644 --- a/content/types/models/operations/add_playlist_contents_response/typescript.mdx +++ b/content/types/models/operations/add_playlist_contents_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.AddPlaylistContentsResponseBody`}* +Playlist Updated + + import('/content/types/models/operations/add_playlist_contents_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/add_playlist_contents_response_body/go.mdx b/content/types/models/operations/add_playlist_contents_response_body/go.mdx new file mode 100644 index 0000000..ee6695b --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.AddPlaylistContentsMediaContainer`}* + + import('/content/types/models/operations/add_playlist_contents_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/add_playlist_contents_response_body/python.mdx b/content/types/models/operations/add_playlist_contents_response_body/python.mdx new file mode 100644 index 0000000..12f0f8d --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.AddPlaylistContentsMediaContainer]`}* + + import('/content/types/models/operations/add_playlist_contents_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/add_playlist_contents_response_body/typescript.mdx b/content/types/models/operations/add_playlist_contents_response_body/typescript.mdx new file mode 100644 index 0000000..c24d4f5 --- /dev/null +++ b/content/types/models/operations/add_playlist_contents_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.AddPlaylistContentsMediaContainer`}* + + import('/content/types/models/operations/add_playlist_contents_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_media_container/go.mdx b/content/types/models/operations/create_playlist_media_container/go.mdx new file mode 100644 index 0000000..f7d9994 --- /dev/null +++ b/content/types/models/operations/create_playlist_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `7` + +--- +##### `Metadata` *{`[]operations.CreatePlaylistMetadata`}* +
+**Example:** `[{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}]` + + import('/content/types/models/operations/create_playlist_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_media_container/python.mdx b/content/types/models/operations/create_playlist_media_container/python.mdx new file mode 100644 index 0000000..82291f4 --- /dev/null +++ b/content/types/models/operations/create_playlist_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `7` + +--- +##### `metadata` *{`List[operations.CreatePlaylistMetadata]`}* +
+**Example:** `[{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}]` + + import('/content/types/models/operations/create_playlist_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_media_container/typescript.mdx b/content/types/models/operations/create_playlist_media_container/typescript.mdx new file mode 100644 index 0000000..d0f7284 --- /dev/null +++ b/content/types/models/operations/create_playlist_media_container/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `7` + +--- +##### `metadata?`: *{`operations.CreatePlaylistMetadata[]`}* +
+**Example:** `[{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}]` + + import('/content/types/models/operations/create_playlist_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_metadata/go.mdx b/content/types/models/operations/create_playlist_metadata/go.mdx new file mode 100644 index 0000000..d426874 --- /dev/null +++ b/content/types/models/operations/create_playlist_metadata/go.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `96` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/96/items` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `Title` *{`*string`}* +
+**Example:** `A Great Playlist` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `What a great playlist` + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `false` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `Icon` *{`*string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1705719589` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705719589` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705724593` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/96/composite/1705724593` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141000` + + diff --git a/content/types/models/operations/create_playlist_metadata/python.mdx b/content/types/models/operations/create_playlist_metadata/python.mdx new file mode 100644 index 0000000..273ae7c --- /dev/null +++ b/content/types/models/operations/create_playlist_metadata/python.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `96` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/96/items` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `A Great Playlist` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `What a great playlist` + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `icon` *{`Optional[str]`}* +
+**Example:** `playlist://image.smart` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1705719589` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705719589` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705724593` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/96/composite/1705724593` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141000` + + diff --git a/content/types/models/operations/create_playlist_metadata/typescript.mdx b/content/types/models/operations/create_playlist_metadata/typescript.mdx new file mode 100644 index 0000000..510a30b --- /dev/null +++ b/content/types/models/operations/create_playlist_metadata/typescript.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `96` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/96/items` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `title?`: *{`string`}* +
+**Example:** `A Great Playlist` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `What a great playlist` + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `icon?`: *{`string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1705719589` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705719589` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705724593` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/96/composite/1705724593` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141000` + + diff --git a/content/types/models/operations/create_playlist_request/go.mdx b/content/types/models/operations/create_playlist_request/go.mdx index 625c265..34685e5 100644 --- a/content/types/models/operations/create_playlist_request/go.mdx +++ b/content/types/models/operations/create_playlist_request/go.mdx @@ -20,7 +20,7 @@ whether the playlist is smart or not --- -##### `URI` *{`*string`}* +##### `URI` *{`string`}* the content URI for the playlist --- diff --git a/content/types/models/operations/create_playlist_request/python.mdx b/content/types/models/operations/create_playlist_request/python.mdx index 02836a4..a1804b9 100644 --- a/content/types/models/operations/create_playlist_request/python.mdx +++ b/content/types/models/operations/create_playlist_request/python.mdx @@ -20,7 +20,7 @@ whether the playlist is smart or not --- -##### `uri` *{`Optional[str]`}* +##### `uri` *{`str`}* the content URI for the playlist --- diff --git a/content/types/models/operations/create_playlist_request/typescript.mdx b/content/types/models/operations/create_playlist_request/typescript.mdx index e1b47a3..2af0b3c 100644 --- a/content/types/models/operations/create_playlist_request/typescript.mdx +++ b/content/types/models/operations/create_playlist_request/typescript.mdx @@ -20,7 +20,7 @@ whether the playlist is smart or not --- -##### `uri?`: *{`string`}* +##### `uri`: *{`string`}* the content URI for the playlist --- diff --git a/content/types/models/operations/create_playlist_response/go.mdx b/content/types/models/operations/create_playlist_response/go.mdx index 3b4ae5c..46cd3c5 100644 --- a/content/types/models/operations/create_playlist_response/go.mdx +++ b/content/types/models/operations/create_playlist_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.CreatePlaylistResponseBody`}* +returns all playlists + + import('/content/types/models/operations/create_playlist_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/create_playlist_response/python.mdx b/content/types/models/operations/create_playlist_response/python.mdx index 93ee0a0..423bf47 100644 --- a/content/types/models/operations/create_playlist_response/python.mdx +++ b/content/types/models/operations/create_playlist_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.CreatePlaylistResponseBody]`}* +returns all playlists + + import('/content/types/models/operations/create_playlist_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/create_playlist_response/typescript.mdx b/content/types/models/operations/create_playlist_response/typescript.mdx index 2035a36..d103ff0 100644 --- a/content/types/models/operations/create_playlist_response/typescript.mdx +++ b/content/types/models/operations/create_playlist_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.CreatePlaylistResponseBody`}* +returns all playlists + + import('/content/types/models/operations/create_playlist_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/create_playlist_response_body/go.mdx b/content/types/models/operations/create_playlist_response_body/go.mdx new file mode 100644 index 0000000..d27de2a --- /dev/null +++ b/content/types/models/operations/create_playlist_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.CreatePlaylistMediaContainer`}* + + import('/content/types/models/operations/create_playlist_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_response_body/python.mdx b/content/types/models/operations/create_playlist_response_body/python.mdx new file mode 100644 index 0000000..9befaca --- /dev/null +++ b/content/types/models/operations/create_playlist_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.CreatePlaylistMediaContainer]`}* + + import('/content/types/models/operations/create_playlist_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/create_playlist_response_body/typescript.mdx b/content/types/models/operations/create_playlist_response_body/typescript.mdx new file mode 100644 index 0000000..06481b5 --- /dev/null +++ b/content/types/models/operations/create_playlist_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.CreatePlaylistMediaContainer`}* + + import('/content/types/models/operations/create_playlist_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/field/go.mdx b/content/types/models/operations/field/go.mdx new file mode 100644 index 0000000..61d8a15 --- /dev/null +++ b/content/types/models/operations/field/go.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Key` *{`*string`}* +
+**Example:** `label` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Label` + +--- +##### `Type` *{`*string`}* +
+**Example:** `tag` + +--- +##### `SubType` *{`*string`}* +
+**Example:** `bitrate` + + diff --git a/content/types/models/operations/field/python.mdx b/content/types/models/operations/field/python.mdx new file mode 100644 index 0000000..d4d1ea3 --- /dev/null +++ b/content/types/models/operations/field/python.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` *{`Optional[str]`}* +
+**Example:** `label` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Label` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `tag` + +--- +##### `sub_type` *{`Optional[str]`}* +
+**Example:** `bitrate` + + diff --git a/content/types/models/operations/field/typescript.mdx b/content/types/models/operations/field/typescript.mdx new file mode 100644 index 0000000..1e0f686 --- /dev/null +++ b/content/types/models/operations/field/typescript.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key?`: *{`string`}* +
+**Example:** `label` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Label` + +--- +##### `type?`: *{`string`}* +
+**Example:** `tag` + +--- +##### `subType?`: *{`string`}* +
+**Example:** `bitrate` + + diff --git a/content/types/models/operations/field_type/go.mdx b/content/types/models/operations/field_type/go.mdx new file mode 100644 index 0000000..3c3ae70 --- /dev/null +++ b/content/types/models/operations/field_type/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Type` *{`*string`}* +
+**Example:** `resolution` + +--- +##### `Operator` *{`[]operations.Operator`}* +
+**Example:** `[{"key":"=","title":"is"}]` + + import('/content/types/models/operations/operator/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/field_type/python.mdx b/content/types/models/operations/field_type/python.mdx new file mode 100644 index 0000000..a8101c9 --- /dev/null +++ b/content/types/models/operations/field_type/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type` *{`Optional[str]`}* +
+**Example:** `resolution` + +--- +##### `operator` *{`List[operations.Operator]`}* +
+**Example:** `[{"key":"=","title":"is"}]` + + import('/content/types/models/operations/operator/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/field_type/typescript.mdx b/content/types/models/operations/field_type/typescript.mdx new file mode 100644 index 0000000..a086127 --- /dev/null +++ b/content/types/models/operations/field_type/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type?`: *{`string`}* +
+**Example:** `resolution` + +--- +##### `operator?`: *{`operations.Operator[]`}* +
+**Example:** `[{"key":"=","title":"is"}]` + + import('/content/types/models/operations/operator/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/filter/go.mdx b/content/types/models/operations/filter/go.mdx new file mode 100644 index 0000000..ade2b6f --- /dev/null +++ b/content/types/models/operations/filter/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Filter` *{`*string`}* +
+**Example:** `label` + +--- +##### `FilterType` *{`*string`}* +
+**Example:** `string` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/sections/1/label` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Labels` + +--- +##### `Type` *{`*string`}* +
+**Example:** `filter` + + diff --git a/content/types/models/operations/filter/python.mdx b/content/types/models/operations/filter/python.mdx new file mode 100644 index 0000000..c5a13f8 --- /dev/null +++ b/content/types/models/operations/filter/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `filter_` *{`Optional[str]`}* +
+**Example:** `label` + +--- +##### `filter_type` *{`Optional[str]`}* +
+**Example:** `string` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1/label` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Labels` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `filter` + + diff --git a/content/types/models/operations/filter/typescript.mdx b/content/types/models/operations/filter/typescript.mdx new file mode 100644 index 0000000..b6bab8d --- /dev/null +++ b/content/types/models/operations/filter/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `filter?`: *{`string`}* +
+**Example:** `label` + +--- +##### `filterType?`: *{`string`}* +
+**Example:** `string` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/sections/1/label` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Labels` + +--- +##### `type?`: *{`string`}* +
+**Example:** `filter` + + diff --git a/content/types/models/operations/get_available_clients_response/go.mdx b/content/types/models/operations/get_available_clients_response/go.mdx index 86123d6..8f0fc66 100644 --- a/content/types/models/operations/get_available_clients_response/go.mdx +++ b/content/types/models/operations/get_available_clients_response/go.mdx @@ -14,10 +14,10 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `Classes` *{`[]operations.ResponseBody`}* +##### `Object` *{`*operations.GetAvailableClientsResponseBody`}* Available Clients - import('/content/types/models/operations/response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_available_clients_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_available_clients_response/python.mdx b/content/types/models/operations/get_available_clients_response/python.mdx index 717ab94..f4b1b64 100644 --- a/content/types/models/operations/get_available_clients_response/python.mdx +++ b/content/types/models/operations/get_available_clients_response/python.mdx @@ -14,10 +14,10 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `classes` *{`List[operations.ResponseBody]`}* +##### `object` *{`Optional[operations.GetAvailableClientsResponseBody]`}* Available Clients - import('/content/types/models/operations/response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_available_clients_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_available_clients_response/typescript.mdx b/content/types/models/operations/get_available_clients_response/typescript.mdx index 8394e8e..17ba666 100644 --- a/content/types/models/operations/get_available_clients_response/typescript.mdx +++ b/content/types/models/operations/get_available_clients_response/typescript.mdx @@ -14,10 +14,10 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `classes?`: *{`operations.ResponseBody[]`}* +##### `object?`: *{`operations.GetAvailableClientsResponseBody`}* Available Clients - import('/content/types/models/operations/response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_available_clients_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/response_body/go.mdx b/content/types/models/operations/get_available_clients_response_body/go.mdx similarity index 100% rename from content/types/models/operations/response_body/go.mdx rename to content/types/models/operations/get_available_clients_response_body/go.mdx diff --git a/content/types/models/operations/response_body/python.mdx b/content/types/models/operations/get_available_clients_response_body/python.mdx similarity index 100% rename from content/types/models/operations/response_body/python.mdx rename to content/types/models/operations/get_available_clients_response_body/python.mdx diff --git a/content/types/models/operations/response_body/typescript.mdx b/content/types/models/operations/get_available_clients_response_body/typescript.mdx similarity index 100% rename from content/types/models/operations/response_body/typescript.mdx rename to content/types/models/operations/get_available_clients_response_body/typescript.mdx diff --git a/content/types/models/operations/get_common_library_items_request/go.mdx b/content/types/models/operations/get_common_library_items_request/go.mdx deleted file mode 100644 index 140a262..0000000 --- a/content/types/models/operations/get_common_library_items_request/go.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `SectionID` *{`float64`}* -the Id of the library to query - ---- -##### `Type` *{`float64`}* -item type - ---- -##### `Filter` *{`*string`}* -the filter parameter - - diff --git a/content/types/models/operations/get_common_library_items_request/python.mdx b/content/types/models/operations/get_common_library_items_request/python.mdx deleted file mode 100644 index 360caa2..0000000 --- a/content/types/models/operations/get_common_library_items_request/python.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - - diff --git a/content/types/models/operations/get_common_library_items_request/typescript.mdx b/content/types/models/operations/get_common_library_items_request/typescript.mdx deleted file mode 100644 index 513d3d9..0000000 --- a/content/types/models/operations/get_common_library_items_request/typescript.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - - diff --git a/content/types/models/operations/get_common_library_items_response/go.mdx b/content/types/models/operations/get_common_library_items_response/go.mdx deleted file mode 100644 index 3b4ae5c..0000000 --- a/content/types/models/operations/get_common_library_items_response/go.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ContentType` *{`string`}* -HTTP response content type for this operation - ---- -##### `StatusCode` *{`int`}* -HTTP response status code for this operation - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_common_library_items_response/python.mdx b/content/types/models/operations/get_common_library_items_response/python.mdx deleted file mode 100644 index 93ee0a0..0000000 --- a/content/types/models/operations/get_common_library_items_response/python.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `content_type` *{`str`}* -HTTP response content type for this operation - ---- -##### `status_code` *{`int`}* -HTTP response status code for this operation - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_common_library_items_response/typescript.mdx b/content/types/models/operations/get_common_library_items_response/typescript.mdx deleted file mode 100644 index 2035a36..0000000 --- a/content/types/models/operations/get_common_library_items_response/typescript.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `contentType`: *{`string`}* -HTTP response content type for this operation - ---- -##### `statusCode`: *{`number`}* -HTTP response status code for this operation - ---- -##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_global_hubs_media_container/go.mdx b/content/types/models/operations/get_global_hubs_media_container/go.mdx new file mode 100644 index 0000000..39efce5 --- /dev/null +++ b/content/types/models/operations/get_global_hubs_media_container/go.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `8` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `Hub` *{`[]operations.Hub`}* +
+**Example:** `[{"Metadata":[{"addedAt":1655309388,"composite":"/playlists/50768/composite/1704333758","duration":42864000,"guid":"com.plexapp.agents.none://81658e0d-cd4e-4c73-abb9-832b2ae2037b","icon":"playlist://image.smart","key":"/playlists/50768/items","lastViewedAt":1705329935,"leafCount":178,"playlistType":"audio","ratingKey":"50768","smart":true,"summary":"All your highly rated tracks, in one convenient place.","title":"❤️ Tracks","titleSort":"Tracks","type":"playlist","updatedAt":1704333758,"viewCount":47},{"addedAt":1697993545,"composite":"/playlists/65523/composite/1698597932","duration":4864000,"guid":"com.plexapp.agents.none://1bcdd596-892b-4856-9f28-b4338c439300","key":"/playlists/65523/items","lastViewedAt":1698597949,"leafCount":19,"playlistType":"audio","ratingKey":"65523","smart":false,"summary":"","title":"Car Rides","type":"playlist","updatedAt":1698597932,"viewCount":2},{"addedAt":1679616785,"composite":"/playlists/58188/composite/1680825595","duration":12522000,"guid":"com.plexapp.agents.none://8f0441d3-2a28-4644-a2f1-b7deeb290dff","key":"/playlists/58188/items","lastViewedAt":1680825596,"leafCount":56,"playlistType":"audio","ratingKey":"58188","smart":false,"summary":"","title":"Workout","type":"playlist","updatedAt":1680825595,"viewCount":4},{"addedAt":1673372306,"composite":"/playlists/57341/composite/1673372385","duration":19119000,"guid":"com.plexapp.agents.none://bf8778c3-20a3-4619-8eb0-3c172c18ffd6","key":"/playlists/57341/items","lastViewedAt":1673372306,"leafCount":3,"playlistType":"video","ratingKey":"57341","smart":false,"summary":"","title":"January Movie Day","type":"playlist","updatedAt":1673372385,"viewCount":1},{"addedAt":1671197078,"composite":"/playlists/57302/composite/1671205874","duration":23040000,"guid":"com.plexapp.agents.none://f25064ed-05bb-4bcf-b70c-ed7514b70929","key":"/playlists/57302/items","lastViewedAt":1671206853,"leafCount":3,"playlistType":"video","ratingKey":"57302","smart":false,"summary":"","title":"December Movie Day","type":"playlist","updatedAt":1671205874,"viewCount":2},{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","type":"playlist","updatedAt":1668787730,"viewCount":2}],"context":"hub.home.playlists","hubIdentifier":"home.playlists","hubKey":"/library/metadata/50768,65523,58188,57341,57302,57070","key":"/playlists/all?type=15\u0026sort=lastViewedAt:desc\u0026playlistType=video,audio","more":true,"promoted":true,"size":6,"style":"shelf","title":"Recent Playlists","type":"playlist"}]` + + import('/content/types/models/operations/hub/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_global_hubs_media_container/python.mdx b/content/types/models/operations/get_global_hubs_media_container/python.mdx new file mode 100644 index 0000000..e4f4ea4 --- /dev/null +++ b/content/types/models/operations/get_global_hubs_media_container/python.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `8` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `hub` *{`List[operations.Hub]`}* +
+**Example:** `[{"Metadata":[{"addedAt":1655309388,"composite":"/playlists/50768/composite/1704333758","duration":42864000,"guid":"com.plexapp.agents.none://81658e0d-cd4e-4c73-abb9-832b2ae2037b","icon":"playlist://image.smart","key":"/playlists/50768/items","lastViewedAt":1705329935,"leafCount":178,"playlistType":"audio","ratingKey":"50768","smart":true,"summary":"All your highly rated tracks, in one convenient place.","title":"❤️ Tracks","titleSort":"Tracks","type":"playlist","updatedAt":1704333758,"viewCount":47},{"addedAt":1697993545,"composite":"/playlists/65523/composite/1698597932","duration":4864000,"guid":"com.plexapp.agents.none://1bcdd596-892b-4856-9f28-b4338c439300","key":"/playlists/65523/items","lastViewedAt":1698597949,"leafCount":19,"playlistType":"audio","ratingKey":"65523","smart":false,"summary":"","title":"Car Rides","type":"playlist","updatedAt":1698597932,"viewCount":2},{"addedAt":1679616785,"composite":"/playlists/58188/composite/1680825595","duration":12522000,"guid":"com.plexapp.agents.none://8f0441d3-2a28-4644-a2f1-b7deeb290dff","key":"/playlists/58188/items","lastViewedAt":1680825596,"leafCount":56,"playlistType":"audio","ratingKey":"58188","smart":false,"summary":"","title":"Workout","type":"playlist","updatedAt":1680825595,"viewCount":4},{"addedAt":1673372306,"composite":"/playlists/57341/composite/1673372385","duration":19119000,"guid":"com.plexapp.agents.none://bf8778c3-20a3-4619-8eb0-3c172c18ffd6","key":"/playlists/57341/items","lastViewedAt":1673372306,"leafCount":3,"playlistType":"video","ratingKey":"57341","smart":false,"summary":"","title":"January Movie Day","type":"playlist","updatedAt":1673372385,"viewCount":1},{"addedAt":1671197078,"composite":"/playlists/57302/composite/1671205874","duration":23040000,"guid":"com.plexapp.agents.none://f25064ed-05bb-4bcf-b70c-ed7514b70929","key":"/playlists/57302/items","lastViewedAt":1671206853,"leafCount":3,"playlistType":"video","ratingKey":"57302","smart":false,"summary":"","title":"December Movie Day","type":"playlist","updatedAt":1671205874,"viewCount":2},{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","type":"playlist","updatedAt":1668787730,"viewCount":2}],"context":"hub.home.playlists","hubIdentifier":"home.playlists","hubKey":"/library/metadata/50768,65523,58188,57341,57302,57070","key":"/playlists/all?type=15\u0026sort=lastViewedAt:desc\u0026playlistType=video,audio","more":true,"promoted":true,"size":6,"style":"shelf","title":"Recent Playlists","type":"playlist"}]` + + import('/content/types/models/operations/hub/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_global_hubs_media_container/typescript.mdx b/content/types/models/operations/get_global_hubs_media_container/typescript.mdx new file mode 100644 index 0000000..a52b213 --- /dev/null +++ b/content/types/models/operations/get_global_hubs_media_container/typescript.mdx @@ -0,0 +1,27 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `8` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `hub?`: *{`operations.Hub[]`}* +
+**Example:** `[{"Metadata":[{"addedAt":1655309388,"composite":"/playlists/50768/composite/1704333758","duration":42864000,"guid":"com.plexapp.agents.none://81658e0d-cd4e-4c73-abb9-832b2ae2037b","icon":"playlist://image.smart","key":"/playlists/50768/items","lastViewedAt":1705329935,"leafCount":178,"playlistType":"audio","ratingKey":"50768","smart":true,"summary":"All your highly rated tracks, in one convenient place.","title":"❤️ Tracks","titleSort":"Tracks","type":"playlist","updatedAt":1704333758,"viewCount":47},{"addedAt":1697993545,"composite":"/playlists/65523/composite/1698597932","duration":4864000,"guid":"com.plexapp.agents.none://1bcdd596-892b-4856-9f28-b4338c439300","key":"/playlists/65523/items","lastViewedAt":1698597949,"leafCount":19,"playlistType":"audio","ratingKey":"65523","smart":false,"summary":"","title":"Car Rides","type":"playlist","updatedAt":1698597932,"viewCount":2},{"addedAt":1679616785,"composite":"/playlists/58188/composite/1680825595","duration":12522000,"guid":"com.plexapp.agents.none://8f0441d3-2a28-4644-a2f1-b7deeb290dff","key":"/playlists/58188/items","lastViewedAt":1680825596,"leafCount":56,"playlistType":"audio","ratingKey":"58188","smart":false,"summary":"","title":"Workout","type":"playlist","updatedAt":1680825595,"viewCount":4},{"addedAt":1673372306,"composite":"/playlists/57341/composite/1673372385","duration":19119000,"guid":"com.plexapp.agents.none://bf8778c3-20a3-4619-8eb0-3c172c18ffd6","key":"/playlists/57341/items","lastViewedAt":1673372306,"leafCount":3,"playlistType":"video","ratingKey":"57341","smart":false,"summary":"","title":"January Movie Day","type":"playlist","updatedAt":1673372385,"viewCount":1},{"addedAt":1671197078,"composite":"/playlists/57302/composite/1671205874","duration":23040000,"guid":"com.plexapp.agents.none://f25064ed-05bb-4bcf-b70c-ed7514b70929","key":"/playlists/57302/items","lastViewedAt":1671206853,"leafCount":3,"playlistType":"video","ratingKey":"57302","smart":false,"summary":"","title":"December Movie Day","type":"playlist","updatedAt":1671205874,"viewCount":2},{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","type":"playlist","updatedAt":1668787730,"viewCount":2}],"context":"hub.home.playlists","hubIdentifier":"home.playlists","hubKey":"/library/metadata/50768,65523,58188,57341,57302,57070","key":"/playlists/all?type=15\u0026sort=lastViewedAt:desc\u0026playlistType=video,audio","more":true,"promoted":true,"size":6,"style":"shelf","title":"Recent Playlists","type":"playlist"}]` + + import('/content/types/models/operations/hub/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_global_hubs_metadata/go.mdx b/content/types/models/operations/get_global_hubs_metadata/go.mdx new file mode 100644 index 0000000..325272e --- /dev/null +++ b/content/types/models/operations/get_global_hubs_metadata/go.mdx @@ -0,0 +1,84 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `57070` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/57070/items` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `Title` *{`*string`}* +
+**Example:** `November Movie Day` + +--- +##### `TitleSort` *{`*string`}* +
+**Example:** `Tracks` + +--- +##### `Summary` *{`*string`}* + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `false` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/57070/composite/1668787730` + +--- +##### `Icon` *{`*string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `2` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1668787732` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `16873000` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `3` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1668779618` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1668787730` + + diff --git a/content/types/models/operations/get_global_hubs_metadata/python.mdx b/content/types/models/operations/get_global_hubs_metadata/python.mdx new file mode 100644 index 0000000..e7d4521 --- /dev/null +++ b/content/types/models/operations/get_global_hubs_metadata/python.mdx @@ -0,0 +1,84 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `57070` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/57070/items` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `November Movie Day` + +--- +##### `title_sort` *{`Optional[str]`}* +
+**Example:** `Tracks` + +--- +##### `summary` *{`Optional[str]`}* + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/57070/composite/1668787730` + +--- +##### `icon` *{`Optional[str]`}* +
+**Example:** `playlist://image.smart` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1668787732` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `16873000` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `3` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1668779618` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1668787730` + + diff --git a/content/types/models/operations/get_global_hubs_metadata/typescript.mdx b/content/types/models/operations/get_global_hubs_metadata/typescript.mdx new file mode 100644 index 0000000..7cdf97b --- /dev/null +++ b/content/types/models/operations/get_global_hubs_metadata/typescript.mdx @@ -0,0 +1,84 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `57070` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/57070/items` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `title?`: *{`string`}* +
+**Example:** `November Movie Day` + +--- +##### `titleSort?`: *{`string`}* +
+**Example:** `Tracks` + +--- +##### `summary?`: *{`string`}* + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/57070/composite/1668787730` + +--- +##### `icon?`: *{`string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `2` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1668787732` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `16873000` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `3` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1668779618` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1668787730` + + diff --git a/content/types/models/operations/get_global_hubs_response/go.mdx b/content/types/models/operations/get_global_hubs_response/go.mdx index 3b4ae5c..56e58c6 100644 --- a/content/types/models/operations/get_global_hubs_response/go.mdx +++ b/content/types/models/operations/get_global_hubs_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetGlobalHubsResponseBody`}* +returns global hubs + + import('/content/types/models/operations/get_global_hubs_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_global_hubs_response/python.mdx b/content/types/models/operations/get_global_hubs_response/python.mdx index 93ee0a0..4d016ea 100644 --- a/content/types/models/operations/get_global_hubs_response/python.mdx +++ b/content/types/models/operations/get_global_hubs_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetGlobalHubsResponseBody]`}* +returns global hubs + + import('/content/types/models/operations/get_global_hubs_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_global_hubs_response/typescript.mdx b/content/types/models/operations/get_global_hubs_response/typescript.mdx index 2035a36..7de4fb7 100644 --- a/content/types/models/operations/get_global_hubs_response/typescript.mdx +++ b/content/types/models/operations/get_global_hubs_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetGlobalHubsResponseBody`}* +returns global hubs + + import('/content/types/models/operations/get_global_hubs_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_global_hubs_response_body/go.mdx b/content/types/models/operations/get_global_hubs_response_body/go.mdx new file mode 100644 index 0000000..71aa750 --- /dev/null +++ b/content/types/models/operations/get_global_hubs_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetGlobalHubsMediaContainer`}* + + import('/content/types/models/operations/get_global_hubs_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_global_hubs_response_body/python.mdx b/content/types/models/operations/get_global_hubs_response_body/python.mdx new file mode 100644 index 0000000..be8985e --- /dev/null +++ b/content/types/models/operations/get_global_hubs_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetGlobalHubsMediaContainer]`}* + + import('/content/types/models/operations/get_global_hubs_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_global_hubs_response_body/typescript.mdx b/content/types/models/operations/get_global_hubs_response_body/typescript.mdx new file mode 100644 index 0000000..d29fb1e --- /dev/null +++ b/content/types/models/operations/get_global_hubs_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetGlobalHubsMediaContainer`}* + + import('/content/types/models/operations/get_global_hubs_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_latest_library_items_request/go.mdx b/content/types/models/operations/get_latest_library_items_request/go.mdx deleted file mode 100644 index 140a262..0000000 --- a/content/types/models/operations/get_latest_library_items_request/go.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `SectionID` *{`float64`}* -the Id of the library to query - ---- -##### `Type` *{`float64`}* -item type - ---- -##### `Filter` *{`*string`}* -the filter parameter - - diff --git a/content/types/models/operations/get_latest_library_items_request/python.mdx b/content/types/models/operations/get_latest_library_items_request/python.mdx deleted file mode 100644 index 360caa2..0000000 --- a/content/types/models/operations/get_latest_library_items_request/python.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - - diff --git a/content/types/models/operations/get_latest_library_items_request/typescript.mdx b/content/types/models/operations/get_latest_library_items_request/typescript.mdx deleted file mode 100644 index 513d3d9..0000000 --- a/content/types/models/operations/get_latest_library_items_request/typescript.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - - diff --git a/content/types/models/operations/get_latest_library_items_response/go.mdx b/content/types/models/operations/get_latest_library_items_response/go.mdx deleted file mode 100644 index 3b4ae5c..0000000 --- a/content/types/models/operations/get_latest_library_items_response/go.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ContentType` *{`string`}* -HTTP response content type for this operation - ---- -##### `StatusCode` *{`int`}* -HTTP response status code for this operation - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_latest_library_items_response/python.mdx b/content/types/models/operations/get_latest_library_items_response/python.mdx deleted file mode 100644 index 93ee0a0..0000000 --- a/content/types/models/operations/get_latest_library_items_response/python.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `content_type` *{`str`}* -HTTP response content type for this operation - ---- -##### `status_code` *{`int`}* -HTTP response status code for this operation - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_latest_library_items_response/typescript.mdx b/content/types/models/operations/get_latest_library_items_response/typescript.mdx deleted file mode 100644 index 2035a36..0000000 --- a/content/types/models/operations/get_latest_library_items_response/typescript.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `contentType`: *{`string`}* -HTTP response content type for this operation - ---- -##### `statusCode`: *{`number`}* -HTTP response status code for this operation - ---- -##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/operations/get_library_directory/go.mdx b/content/types/models/operations/get_library_directory/go.mdx new file mode 100644 index 0000000..73dfd83 --- /dev/null +++ b/content/types/models/operations/get_library_directory/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Key` *{`*string`}* +
+**Example:** `search?type=1` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Search...` + +--- +##### `Secondary` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Prompt` *{`*string`}* +
+**Example:** `Search Movies` + +--- +##### `Search` *{`*bool`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_directory/python.mdx b/content/types/models/operations/get_library_directory/python.mdx new file mode 100644 index 0000000..20d95cf --- /dev/null +++ b/content/types/models/operations/get_library_directory/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` *{`Optional[str]`}* +
+**Example:** `search?type=1` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Search...` + +--- +##### `secondary` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `prompt` *{`Optional[str]`}* +
+**Example:** `Search Movies` + +--- +##### `search` *{`Optional[bool]`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_directory/typescript.mdx b/content/types/models/operations/get_library_directory/typescript.mdx new file mode 100644 index 0000000..593d881 --- /dev/null +++ b/content/types/models/operations/get_library_directory/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key?`: *{`string`}* +
+**Example:** `search?type=1` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Search...` + +--- +##### `secondary?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `prompt?`: *{`string`}* +
+**Example:** `Search Movies` + +--- +##### `search?`: *{`boolean`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_hubs_country/go.mdx b/content/types/models/operations/get_library_hubs_country/go.mdx new file mode 100644 index 0000000..325b7e8 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_country/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_hubs_country/python.mdx b/content/types/models/operations/get_library_hubs_country/python.mdx new file mode 100644 index 0000000..437d086 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_country/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_hubs_country/typescript.mdx b/content/types/models/operations/get_library_hubs_country/typescript.mdx new file mode 100644 index 0000000..53ee7ea --- /dev/null +++ b/content/types/models/operations/get_library_hubs_country/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_hubs_director/go.mdx b/content/types/models/operations/get_library_hubs_director/go.mdx new file mode 100644 index 0000000..3d4ee24 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_director/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Nathan Greno` + + diff --git a/content/types/models/operations/get_library_hubs_director/python.mdx b/content/types/models/operations/get_library_hubs_director/python.mdx new file mode 100644 index 0000000..7025cd2 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_director/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Nathan Greno` + + diff --git a/content/types/models/operations/get_library_hubs_director/typescript.mdx b/content/types/models/operations/get_library_hubs_director/typescript.mdx new file mode 100644 index 0000000..ce40376 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_director/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Nathan Greno` + + diff --git a/content/types/models/operations/get_library_hubs_genre/go.mdx b/content/types/models/operations/get_library_hubs_genre/go.mdx new file mode 100644 index 0000000..48fc9d0 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_genre/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Animation` + + diff --git a/content/types/models/operations/get_library_hubs_genre/python.mdx b/content/types/models/operations/get_library_hubs_genre/python.mdx new file mode 100644 index 0000000..78d87bd --- /dev/null +++ b/content/types/models/operations/get_library_hubs_genre/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Animation` + + diff --git a/content/types/models/operations/get_library_hubs_genre/typescript.mdx b/content/types/models/operations/get_library_hubs_genre/typescript.mdx new file mode 100644 index 0000000..c3d207d --- /dev/null +++ b/content/types/models/operations/get_library_hubs_genre/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Animation` + + diff --git a/content/types/models/operations/get_library_hubs_hub/go.mdx b/content/types/models/operations/get_library_hubs_hub/go.mdx new file mode 100644 index 0000000..aff1572 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_hub/go.mdx @@ -0,0 +1,67 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Key` *{`*string`}* +
+**Example:** `/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Recently Played Movies` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `HubIdentifier` *{`*string`}* +
+**Example:** `movie.recentlyviewed.1` + +--- +##### `Context` *{`*string`}* +
+**Example:** `hub.movie.recentlyviewed` + +--- +##### `Size` *{`*int`}* +
+**Example:** `6` + +--- +##### `More` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Style` *{`*string`}* +
+**Example:** `shelf` + +--- +##### `HubKey` *{`*string`}* +
+**Example:** `/library/metadata/66485,66098,57249,11449,5858,14944` + +--- +##### `Metadata` *{`[]operations.GetLibraryHubsMetadata`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","skipCount":1,"studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}]` + + import('/content/types/models/operations/get_library_hubs_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Promoted` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Random` *{`*bool`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_hubs_hub/python.mdx b/content/types/models/operations/get_library_hubs_hub/python.mdx new file mode 100644 index 0000000..878a266 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_hub/python.mdx @@ -0,0 +1,67 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Recently Played Movies` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `hub_identifier` *{`Optional[str]`}* +
+**Example:** `movie.recentlyviewed.1` + +--- +##### `context` *{`Optional[str]`}* +
+**Example:** `hub.movie.recentlyviewed` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `6` + +--- +##### `more` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `style` *{`Optional[str]`}* +
+**Example:** `shelf` + +--- +##### `hub_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66485,66098,57249,11449,5858,14944` + +--- +##### `metadata` *{`List[operations.GetLibraryHubsMetadata]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","skipCount":1,"studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}]` + + import('/content/types/models/operations/get_library_hubs_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `promoted` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `random` *{`Optional[bool]`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_hubs_hub/typescript.mdx b/content/types/models/operations/get_library_hubs_hub/typescript.mdx new file mode 100644 index 0000000..c5db16d --- /dev/null +++ b/content/types/models/operations/get_library_hubs_hub/typescript.mdx @@ -0,0 +1,67 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `key?`: *{`string`}* +
+**Example:** `/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Recently Played Movies` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `hubIdentifier?`: *{`string`}* +
+**Example:** `movie.recentlyviewed.1` + +--- +##### `context?`: *{`string`}* +
+**Example:** `hub.movie.recentlyviewed` + +--- +##### `size?`: *{`number`}* +
+**Example:** `6` + +--- +##### `more?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `style?`: *{`string`}* +
+**Example:** `shelf` + +--- +##### `hubKey?`: *{`string`}* +
+**Example:** `/library/metadata/66485,66098,57249,11449,5858,14944` + +--- +##### `metadata?`: *{`operations.GetLibraryHubsMetadata[]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","skipCount":1,"studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}]` + + import('/content/types/models/operations/get_library_hubs_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `promoted?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `random?`: *{`boolean`}* +
+**Example:** `true` + + diff --git a/content/types/models/operations/get_library_hubs_media/go.mdx b/content/types/models/operations/get_library_hubs_media/go.mdx new file mode 100644 index 0000000..eb4e228 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media/go.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ID` *{`*int`}* +
+**Example:** `38247` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `6017237` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `2051` + +--- +##### `Width` *{`*int`}* +
+**Example:** `1920` + +--- +##### `Height` *{`*int`}* +
+**Example:** `1080` + +--- +##### `AspectRatio` *{`*float64`}* +
+**Example:** `1.78` + +--- +##### `AudioChannels` *{`*int`}* +
+**Example:** `2` + +--- +##### `AudioCodec` *{`*string`}* +
+**Example:** `aac` + +--- +##### `VideoCodec` *{`*string`}* +
+**Example:** `h264` + +--- +##### `VideoResolution` *{`*string`}* +
+**Example:** `1080` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `VideoFrameRate` *{`*string`}* +
+**Example:** `24p` + +--- +##### `OptimizedForStreaming` *{`*int`}* +
+**Example:** `1` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + +--- +##### `Part` *{`[]operations.GetLibraryHubsPart`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_library_hubs_part/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_media/python.mdx b/content/types/models/operations/get_library_hubs_media/python.mdx new file mode 100644 index 0000000..5e32d83 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media/python.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id` *{`Optional[int]`}* +
+**Example:** `38247` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `6017237` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `2051` + +--- +##### `width` *{`Optional[int]`}* +
+**Example:** `1920` + +--- +##### `height` *{`Optional[int]`}* +
+**Example:** `1080` + +--- +##### `aspect_ratio` *{`Optional[float]`}* +
+**Example:** `1.78` + +--- +##### `audio_channels` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `audio_codec` *{`Optional[str]`}* +
+**Example:** `aac` + +--- +##### `video_codec` *{`Optional[str]`}* +
+**Example:** `h264` + +--- +##### `video_resolution` *{`Optional[str]`}* +
+**Example:** `1080` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `video_frame_rate` *{`Optional[str]`}* +
+**Example:** `24p` + +--- +##### `optimized_for_streaming` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + +--- +##### `part` *{`List[operations.GetLibraryHubsPart]`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_library_hubs_part/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_media/typescript.mdx b/content/types/models/operations/get_library_hubs_media/typescript.mdx new file mode 100644 index 0000000..a036261 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media/typescript.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id?`: *{`number`}* +
+**Example:** `38247` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `6017237` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `2051` + +--- +##### `width?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `height?`: *{`number`}* +
+**Example:** `1080` + +--- +##### `aspectRatio?`: *{`number`}* +
+**Example:** `1.78` + +--- +##### `audioChannels?`: *{`number`}* +
+**Example:** `2` + +--- +##### `audioCodec?`: *{`string`}* +
+**Example:** `aac` + +--- +##### `videoCodec?`: *{`string`}* +
+**Example:** `h264` + +--- +##### `videoResolution?`: *{`string`}* +
+**Example:** `1080` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `videoFrameRate?`: *{`string`}* +
+**Example:** `24p` + +--- +##### `optimizedForStreaming?`: *{`number`}* +
+**Example:** `1` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + +--- +##### `part?`: *{`operations.GetLibraryHubsPart[]`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_library_hubs_part/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_media_container/go.mdx b/content/types/models/operations/get_library_hubs_media_container/go.mdx new file mode 100644 index 0000000..b059271 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media_container/go.mdx @@ -0,0 +1,42 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `7` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionUUID` *{`*string`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `Hub` *{`[]operations.GetLibraryHubsHub`}* +
+**Example:** `[{"Metadata":[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Ceyda Torun"}],"Genre":[{"tag":"Documentary"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":4736174,"file":"/movies/Kedi (2017)/Kedi (2017) 1080p x264.mp4","has64bitOffsets":false,"id":129778,"key":"/library/parts/129778/1702586883/file.mp4","optimizedForStreaming":false,"size":1410810905,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2377,"container":"mp4","duration":4736174,"has64bitOffsets":false,"height":1080,"id":129531,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Bülent Üstün"}],"addedAt":1702586905,"art":"/library/metadata/66485/art/1702586907","audienceRating":8.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"Not Rated","duration":4736174,"guid":"plex://movie/5d776c3251dd69001fe38bb4","key":"/library/metadata/66485","lastViewedAt":1705786111,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2017-02-10T00:00:00Z","primaryExtraKey":"/library/metadata/66486","rating":9.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66485","studio":"Termite Films","summary":"A profile of an ancient city and its unique people, seen through the eyes of the most mysterious and beloved animal humans have ever known, the Cat.","tagline":"A cat meowing at your feet, looking up at you, is life smiling at you...","thumb":"/library/metadata/66485/thumb/1702586907","title":"Kedi","type":"movie","updatedAt":1702586907,"viewCount":2,"year":2017},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Duwayne Dunham"}],"Genre":[{"tag":"Adventure"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":5065775,"file":"/movies/Homeward Bound The Incredible Journey (1993)/Homeward Bound The Incredible Journey (1993) [BluRay] [1080p] [YTS.LT].mp4","has64bitOffsets":false,"id":129250,"key":"/library/parts/129250/1700434864/file.mp4","optimizedForStreaming":true,"size":1550855333,"videoProfile":"high"}],"aspectRatio":1.85,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2444,"container":"mp4","duration":5065775,"has64bitOffsets":false,"height":1024,"id":129003,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1904}],"Role":[{"tag":"Michael J. Fox"},{"tag":"Sally Field"},{"tag":"Don Ameche"}],"Writer":[{"tag":"Caroline Thompson"},{"tag":"Linda Woolverton"}],"addedAt":1700434925,"art":"/library/metadata/66098/art/1703148781","audienceRating":7.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"G","duration":5065775,"guid":"plex://movie/5d9f34f4adeb7a0021ce020f","key":"/library/metadata/66098","lastViewedAt":1705709811,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"1993-02-12T00:00:00Z","primaryExtraKey":"/library/metadata/66099","rating":8.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66098","studio":"Touchwood Pacific Partners 1","summary":"A fun-loving American bulldog pup, a hilarious Himalayan cat, and a wise old golden retriever embark on a long trek through the rugged wilderness of the Sierra Nevada mountains in a quest to reach home and their beloved owners.","tagline":"In the classic tradition of Walt Disney Pictures comes a story about courage, adventure and friendship.","thumb":"/library/metadata/66098/thumb/1703148781","title":"Homeward Bound: The Incredible Journey","type":"movie","updatedAt":1703148781,"viewCount":2,"year":1993},{"Country":[{"tag":"Canada"},{"tag":"Ireland"}],"Director":[{"tag":"Matt Stawski"}],"Genre":[{"tag":"Comedy"},{"tag":"Family"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mkv","duration":4459050,"file":"/movies/Blue's Big City Adventure (2022)/Blues.Big.City.Adventure.2022.2160p.4K.WEB.x265.10bit.AAC5.1-[YTS.MX].mkv","id":115478,"key":"/library/parts/115478/1669671340/file.mkv","size":3560750664,"videoProfile":"main 10"}],"aspectRatio":1.78,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":6384,"container":"mkv","duration":4459050,"height":2160,"id":115470,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Joshua Dela Cruz"},{"tag":"Steve Burns"},{"tag":"Donovan Patton"}],"Writer":[{"tag":"Traci Paige Johnson"},{"tag":"Todd Kessler"}],"addedAt":1669671356,"art":"/library/metadata/57249/art/1704274800","audienceRating":8.6,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"TV-Y","duration":4459050,"guid":"plex://movie/60eff7d3e22797002c55c1cc","key":"/library/metadata/57249","lastViewedAt":1705681955,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2022-11-18T00:00:00Z","primaryExtraKey":"/library/metadata/57250","rating":8.3,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"57249","skipCount":1,"studio":"Nickelodeon Movies","summary":"Josh and Blue skidoo to New York City to audition for Rainbow Puppy's Broadway musical, but they get lost when Josh accidentally left his Handy Dandy Notebook at home. This leads to a game of Blue's Clues to figure out where the audition is. Meanwhile, Tickety Tock and her friends go to New York City to find Josh and Blue and get to the audition with help from Joe and Steve.","tagline":"All They Need is You.","thumb":"/library/metadata/57249/thumb/1704274800","title":"Blue's Big City Adventure","type":"movie","updatedAt":1704274800,"viewCount":8,"year":2022},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Dan Scanlon"}],"Genre":[{"tag":"Animation"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"ma","container":"mkv","duration":6141428,"file":"/movies/Onward (2020)/Onward (2020) Bluray-1080p.mkv","id":29291,"key":"/library/parts/29291/1589237130/file.mkv","size":8426669232,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":8,"audioCodec":"dca-ma","audioProfile":"ma","bitrate":10977,"container":"mkv","duration":6141428,"height":804,"id":29291,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6142006,"file":"/movies/Onward (2020)/Onward (2020) WEBRip-1080p.mp4","has64bitOffsets":false,"id":29315,"key":"/library/parts/29315/1629002847/file.mp4","optimizedForStreaming":true,"size":2026154995,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2639,"container":"mp4","duration":6142006,"has64bitOffsets":false,"height":800,"id":29315,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Tom Holland"},{"tag":"Chris Pratt"},{"tag":"Julia Louis-Dreyfus"}],"Writer":[{"tag":"Kelsey Mann"},{"tag":"Dan Scanlon"}],"addedAt":1589237130,"art":"/library/metadata/11449/art/1705224000","audienceRating":9.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6141428,"guid":"plex://movie/5d776edfad5437001f803cf9","key":"/library/metadata/11449","lastViewedAt":1705543126,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2020-03-04T00:00:00Z","primaryExtraKey":"/library/metadata/11470","rating":8.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"11449","studio":"Walt Disney Pictures","summary":"In a magical world full of technological advances, elven brothers Ian and Barley Lightfoot set out on an adventure to resurrect their late father for a day.","tagline":"Their quest begineth.","thumb":"/library/metadata/11449/thumb/1705224000","title":"Onward","type":"movie","updatedAt":1705224000,"viewCount":3,"year":2020},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Chris Buck"},{"tag":"Jennifer Lee"}],"Genre":[{"tag":"Adventure"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6194042,"file":"/movies/Frozen II (2019)/Frozen II (2019) Bluray-1080p.mp4","has64bitOffsets":false,"id":14954,"key":"/library/parts/14954/1588207762/file.mp4","optimizedForStreaming":true,"size":1969230037,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2538,"container":"mp4","duration":6194042,"has64bitOffsets":false,"height":800,"id":14954,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6244271,"file":"/movies/Frozen II (2019)/Frozen II (2019) WEBRip-1080p.mp4","has64bitOffsets":false,"id":14999,"key":"/library/parts/14999/1629001526/file.mp4","optimizedForStreaming":true,"size":1983357282,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2536,"container":"mp4","duration":6244271,"has64bitOffsets":false,"height":800,"id":14999,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Idina Menzel"},{"tag":"Kristen Bell"},{"tag":"Josh Gad"}],"Writer":[{"tag":"Chris Buck"},{"tag":"Hans Christian Andersen"}],"addedAt":1588207762,"art":"/library/metadata/5858/art/1704621922","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6194042,"guid":"plex://movie/5d776b85594b2b001e6dc641","key":"/library/metadata/5858","lastViewedAt":1705337663,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2019-11-20T00:00:00Z","primaryExtraKey":"/library/metadata/5892","rating":7.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"5858","skipCount":1,"studio":"Walt Disney Pictures","summary":"Anna, Elsa, Kristoff, Olaf and Sven leave Arendelle to travel to an ancient, autumn-bound forest of an enchanted land. They set out to find the origin of Elsa's powers in order to save their kingdom.","tagline":"The past is not what it seems.","thumb":"/library/metadata/5858/thumb/1704621922","title":"Frozen II","type":"movie","updatedAt":1704621922,"viewCount":1,"year":2019},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}],"context":"hub.movie.recentlyviewed","hubIdentifier":"movie.recentlyviewed.1","hubKey":"/library/metadata/66485,66098,57249,11449,5858,14944","key":"/library/sections/1/all?sort=lastViewedAt:desc\u0026unwatched=0\u0026viewOffset=0","more":true,"promoted":true,"random":true,"size":6,"style":"shelf","title":"Recently Played Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_hubs_hub/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_media_container/python.mdx b/content/types/models/operations/get_library_hubs_media_container/python.mdx new file mode 100644 index 0000000..e24d3a3 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media_container/python.mdx @@ -0,0 +1,42 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `7` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_uuid` *{`Optional[str]`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `hub` *{`List[operations.GetLibraryHubsHub]`}* +
+**Example:** `[{"Metadata":[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Ceyda Torun"}],"Genre":[{"tag":"Documentary"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":4736174,"file":"/movies/Kedi (2017)/Kedi (2017) 1080p x264.mp4","has64bitOffsets":false,"id":129778,"key":"/library/parts/129778/1702586883/file.mp4","optimizedForStreaming":false,"size":1410810905,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2377,"container":"mp4","duration":4736174,"has64bitOffsets":false,"height":1080,"id":129531,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Bülent Üstün"}],"addedAt":1702586905,"art":"/library/metadata/66485/art/1702586907","audienceRating":8.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"Not Rated","duration":4736174,"guid":"plex://movie/5d776c3251dd69001fe38bb4","key":"/library/metadata/66485","lastViewedAt":1705786111,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2017-02-10T00:00:00Z","primaryExtraKey":"/library/metadata/66486","rating":9.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66485","studio":"Termite Films","summary":"A profile of an ancient city and its unique people, seen through the eyes of the most mysterious and beloved animal humans have ever known, the Cat.","tagline":"A cat meowing at your feet, looking up at you, is life smiling at you...","thumb":"/library/metadata/66485/thumb/1702586907","title":"Kedi","type":"movie","updatedAt":1702586907,"viewCount":2,"year":2017},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Duwayne Dunham"}],"Genre":[{"tag":"Adventure"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":5065775,"file":"/movies/Homeward Bound The Incredible Journey (1993)/Homeward Bound The Incredible Journey (1993) [BluRay] [1080p] [YTS.LT].mp4","has64bitOffsets":false,"id":129250,"key":"/library/parts/129250/1700434864/file.mp4","optimizedForStreaming":true,"size":1550855333,"videoProfile":"high"}],"aspectRatio":1.85,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2444,"container":"mp4","duration":5065775,"has64bitOffsets":false,"height":1024,"id":129003,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1904}],"Role":[{"tag":"Michael J. Fox"},{"tag":"Sally Field"},{"tag":"Don Ameche"}],"Writer":[{"tag":"Caroline Thompson"},{"tag":"Linda Woolverton"}],"addedAt":1700434925,"art":"/library/metadata/66098/art/1703148781","audienceRating":7.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"G","duration":5065775,"guid":"plex://movie/5d9f34f4adeb7a0021ce020f","key":"/library/metadata/66098","lastViewedAt":1705709811,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"1993-02-12T00:00:00Z","primaryExtraKey":"/library/metadata/66099","rating":8.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66098","studio":"Touchwood Pacific Partners 1","summary":"A fun-loving American bulldog pup, a hilarious Himalayan cat, and a wise old golden retriever embark on a long trek through the rugged wilderness of the Sierra Nevada mountains in a quest to reach home and their beloved owners.","tagline":"In the classic tradition of Walt Disney Pictures comes a story about courage, adventure and friendship.","thumb":"/library/metadata/66098/thumb/1703148781","title":"Homeward Bound: The Incredible Journey","type":"movie","updatedAt":1703148781,"viewCount":2,"year":1993},{"Country":[{"tag":"Canada"},{"tag":"Ireland"}],"Director":[{"tag":"Matt Stawski"}],"Genre":[{"tag":"Comedy"},{"tag":"Family"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mkv","duration":4459050,"file":"/movies/Blue's Big City Adventure (2022)/Blues.Big.City.Adventure.2022.2160p.4K.WEB.x265.10bit.AAC5.1-[YTS.MX].mkv","id":115478,"key":"/library/parts/115478/1669671340/file.mkv","size":3560750664,"videoProfile":"main 10"}],"aspectRatio":1.78,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":6384,"container":"mkv","duration":4459050,"height":2160,"id":115470,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Joshua Dela Cruz"},{"tag":"Steve Burns"},{"tag":"Donovan Patton"}],"Writer":[{"tag":"Traci Paige Johnson"},{"tag":"Todd Kessler"}],"addedAt":1669671356,"art":"/library/metadata/57249/art/1704274800","audienceRating":8.6,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"TV-Y","duration":4459050,"guid":"plex://movie/60eff7d3e22797002c55c1cc","key":"/library/metadata/57249","lastViewedAt":1705681955,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2022-11-18T00:00:00Z","primaryExtraKey":"/library/metadata/57250","rating":8.3,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"57249","skipCount":1,"studio":"Nickelodeon Movies","summary":"Josh and Blue skidoo to New York City to audition for Rainbow Puppy's Broadway musical, but they get lost when Josh accidentally left his Handy Dandy Notebook at home. This leads to a game of Blue's Clues to figure out where the audition is. Meanwhile, Tickety Tock and her friends go to New York City to find Josh and Blue and get to the audition with help from Joe and Steve.","tagline":"All They Need is You.","thumb":"/library/metadata/57249/thumb/1704274800","title":"Blue's Big City Adventure","type":"movie","updatedAt":1704274800,"viewCount":8,"year":2022},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Dan Scanlon"}],"Genre":[{"tag":"Animation"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"ma","container":"mkv","duration":6141428,"file":"/movies/Onward (2020)/Onward (2020) Bluray-1080p.mkv","id":29291,"key":"/library/parts/29291/1589237130/file.mkv","size":8426669232,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":8,"audioCodec":"dca-ma","audioProfile":"ma","bitrate":10977,"container":"mkv","duration":6141428,"height":804,"id":29291,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6142006,"file":"/movies/Onward (2020)/Onward (2020) WEBRip-1080p.mp4","has64bitOffsets":false,"id":29315,"key":"/library/parts/29315/1629002847/file.mp4","optimizedForStreaming":true,"size":2026154995,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2639,"container":"mp4","duration":6142006,"has64bitOffsets":false,"height":800,"id":29315,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Tom Holland"},{"tag":"Chris Pratt"},{"tag":"Julia Louis-Dreyfus"}],"Writer":[{"tag":"Kelsey Mann"},{"tag":"Dan Scanlon"}],"addedAt":1589237130,"art":"/library/metadata/11449/art/1705224000","audienceRating":9.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6141428,"guid":"plex://movie/5d776edfad5437001f803cf9","key":"/library/metadata/11449","lastViewedAt":1705543126,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2020-03-04T00:00:00Z","primaryExtraKey":"/library/metadata/11470","rating":8.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"11449","studio":"Walt Disney Pictures","summary":"In a magical world full of technological advances, elven brothers Ian and Barley Lightfoot set out on an adventure to resurrect their late father for a day.","tagline":"Their quest begineth.","thumb":"/library/metadata/11449/thumb/1705224000","title":"Onward","type":"movie","updatedAt":1705224000,"viewCount":3,"year":2020},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Chris Buck"},{"tag":"Jennifer Lee"}],"Genre":[{"tag":"Adventure"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6194042,"file":"/movies/Frozen II (2019)/Frozen II (2019) Bluray-1080p.mp4","has64bitOffsets":false,"id":14954,"key":"/library/parts/14954/1588207762/file.mp4","optimizedForStreaming":true,"size":1969230037,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2538,"container":"mp4","duration":6194042,"has64bitOffsets":false,"height":800,"id":14954,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6244271,"file":"/movies/Frozen II (2019)/Frozen II (2019) WEBRip-1080p.mp4","has64bitOffsets":false,"id":14999,"key":"/library/parts/14999/1629001526/file.mp4","optimizedForStreaming":true,"size":1983357282,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2536,"container":"mp4","duration":6244271,"has64bitOffsets":false,"height":800,"id":14999,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Idina Menzel"},{"tag":"Kristen Bell"},{"tag":"Josh Gad"}],"Writer":[{"tag":"Chris Buck"},{"tag":"Hans Christian Andersen"}],"addedAt":1588207762,"art":"/library/metadata/5858/art/1704621922","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6194042,"guid":"plex://movie/5d776b85594b2b001e6dc641","key":"/library/metadata/5858","lastViewedAt":1705337663,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2019-11-20T00:00:00Z","primaryExtraKey":"/library/metadata/5892","rating":7.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"5858","skipCount":1,"studio":"Walt Disney Pictures","summary":"Anna, Elsa, Kristoff, Olaf and Sven leave Arendelle to travel to an ancient, autumn-bound forest of an enchanted land. They set out to find the origin of Elsa's powers in order to save their kingdom.","tagline":"The past is not what it seems.","thumb":"/library/metadata/5858/thumb/1704621922","title":"Frozen II","type":"movie","updatedAt":1704621922,"viewCount":1,"year":2019},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}],"context":"hub.movie.recentlyviewed","hubIdentifier":"movie.recentlyviewed.1","hubKey":"/library/metadata/66485,66098,57249,11449,5858,14944","key":"/library/sections/1/all?sort=lastViewedAt:desc\u0026unwatched=0\u0026viewOffset=0","more":true,"promoted":true,"random":true,"size":6,"style":"shelf","title":"Recently Played Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_hubs_hub/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_media_container/typescript.mdx b/content/types/models/operations/get_library_hubs_media_container/typescript.mdx new file mode 100644 index 0000000..1683298 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_media_container/typescript.mdx @@ -0,0 +1,42 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `7` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionUUID?`: *{`string`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `hub?`: *{`operations.GetLibraryHubsHub[]`}* +
+**Example:** `[{"Metadata":[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Ceyda Torun"}],"Genre":[{"tag":"Documentary"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":4736174,"file":"/movies/Kedi (2017)/Kedi (2017) 1080p x264.mp4","has64bitOffsets":false,"id":129778,"key":"/library/parts/129778/1702586883/file.mp4","optimizedForStreaming":false,"size":1410810905,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2377,"container":"mp4","duration":4736174,"has64bitOffsets":false,"height":1080,"id":129531,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Bülent Üstün"}],"addedAt":1702586905,"art":"/library/metadata/66485/art/1702586907","audienceRating":8.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"Not Rated","duration":4736174,"guid":"plex://movie/5d776c3251dd69001fe38bb4","key":"/library/metadata/66485","lastViewedAt":1705786111,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2017-02-10T00:00:00Z","primaryExtraKey":"/library/metadata/66486","rating":9.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66485","studio":"Termite Films","summary":"A profile of an ancient city and its unique people, seen through the eyes of the most mysterious and beloved animal humans have ever known, the Cat.","tagline":"A cat meowing at your feet, looking up at you, is life smiling at you...","thumb":"/library/metadata/66485/thumb/1702586907","title":"Kedi","type":"movie","updatedAt":1702586907,"viewCount":2,"year":2017},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Duwayne Dunham"}],"Genre":[{"tag":"Adventure"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":5065775,"file":"/movies/Homeward Bound The Incredible Journey (1993)/Homeward Bound The Incredible Journey (1993) [BluRay] [1080p] [YTS.LT].mp4","has64bitOffsets":false,"id":129250,"key":"/library/parts/129250/1700434864/file.mp4","optimizedForStreaming":true,"size":1550855333,"videoProfile":"high"}],"aspectRatio":1.85,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2444,"container":"mp4","duration":5065775,"has64bitOffsets":false,"height":1024,"id":129003,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1904}],"Role":[{"tag":"Michael J. Fox"},{"tag":"Sally Field"},{"tag":"Don Ameche"}],"Writer":[{"tag":"Caroline Thompson"},{"tag":"Linda Woolverton"}],"addedAt":1700434925,"art":"/library/metadata/66098/art/1703148781","audienceRating":7.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"G","duration":5065775,"guid":"plex://movie/5d9f34f4adeb7a0021ce020f","key":"/library/metadata/66098","lastViewedAt":1705709811,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"1993-02-12T00:00:00Z","primaryExtraKey":"/library/metadata/66099","rating":8.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66098","studio":"Touchwood Pacific Partners 1","summary":"A fun-loving American bulldog pup, a hilarious Himalayan cat, and a wise old golden retriever embark on a long trek through the rugged wilderness of the Sierra Nevada mountains in a quest to reach home and their beloved owners.","tagline":"In the classic tradition of Walt Disney Pictures comes a story about courage, adventure and friendship.","thumb":"/library/metadata/66098/thumb/1703148781","title":"Homeward Bound: The Incredible Journey","type":"movie","updatedAt":1703148781,"viewCount":2,"year":1993},{"Country":[{"tag":"Canada"},{"tag":"Ireland"}],"Director":[{"tag":"Matt Stawski"}],"Genre":[{"tag":"Comedy"},{"tag":"Family"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mkv","duration":4459050,"file":"/movies/Blue's Big City Adventure (2022)/Blues.Big.City.Adventure.2022.2160p.4K.WEB.x265.10bit.AAC5.1-[YTS.MX].mkv","id":115478,"key":"/library/parts/115478/1669671340/file.mkv","size":3560750664,"videoProfile":"main 10"}],"aspectRatio":1.78,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":6384,"container":"mkv","duration":4459050,"height":2160,"id":115470,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Joshua Dela Cruz"},{"tag":"Steve Burns"},{"tag":"Donovan Patton"}],"Writer":[{"tag":"Traci Paige Johnson"},{"tag":"Todd Kessler"}],"addedAt":1669671356,"art":"/library/metadata/57249/art/1704274800","audienceRating":8.6,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"TV-Y","duration":4459050,"guid":"plex://movie/60eff7d3e22797002c55c1cc","key":"/library/metadata/57249","lastViewedAt":1705681955,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2022-11-18T00:00:00Z","primaryExtraKey":"/library/metadata/57250","rating":8.3,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"57249","skipCount":1,"studio":"Nickelodeon Movies","summary":"Josh and Blue skidoo to New York City to audition for Rainbow Puppy's Broadway musical, but they get lost when Josh accidentally left his Handy Dandy Notebook at home. This leads to a game of Blue's Clues to figure out where the audition is. Meanwhile, Tickety Tock and her friends go to New York City to find Josh and Blue and get to the audition with help from Joe and Steve.","tagline":"All They Need is You.","thumb":"/library/metadata/57249/thumb/1704274800","title":"Blue's Big City Adventure","type":"movie","updatedAt":1704274800,"viewCount":8,"year":2022},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Dan Scanlon"}],"Genre":[{"tag":"Animation"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"ma","container":"mkv","duration":6141428,"file":"/movies/Onward (2020)/Onward (2020) Bluray-1080p.mkv","id":29291,"key":"/library/parts/29291/1589237130/file.mkv","size":8426669232,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":8,"audioCodec":"dca-ma","audioProfile":"ma","bitrate":10977,"container":"mkv","duration":6141428,"height":804,"id":29291,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6142006,"file":"/movies/Onward (2020)/Onward (2020) WEBRip-1080p.mp4","has64bitOffsets":false,"id":29315,"key":"/library/parts/29315/1629002847/file.mp4","optimizedForStreaming":true,"size":2026154995,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2639,"container":"mp4","duration":6142006,"has64bitOffsets":false,"height":800,"id":29315,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Tom Holland"},{"tag":"Chris Pratt"},{"tag":"Julia Louis-Dreyfus"}],"Writer":[{"tag":"Kelsey Mann"},{"tag":"Dan Scanlon"}],"addedAt":1589237130,"art":"/library/metadata/11449/art/1705224000","audienceRating":9.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6141428,"guid":"plex://movie/5d776edfad5437001f803cf9","key":"/library/metadata/11449","lastViewedAt":1705543126,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2020-03-04T00:00:00Z","primaryExtraKey":"/library/metadata/11470","rating":8.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"11449","studio":"Walt Disney Pictures","summary":"In a magical world full of technological advances, elven brothers Ian and Barley Lightfoot set out on an adventure to resurrect their late father for a day.","tagline":"Their quest begineth.","thumb":"/library/metadata/11449/thumb/1705224000","title":"Onward","type":"movie","updatedAt":1705224000,"viewCount":3,"year":2020},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Chris Buck"},{"tag":"Jennifer Lee"}],"Genre":[{"tag":"Adventure"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6194042,"file":"/movies/Frozen II (2019)/Frozen II (2019) Bluray-1080p.mp4","has64bitOffsets":false,"id":14954,"key":"/library/parts/14954/1588207762/file.mp4","optimizedForStreaming":true,"size":1969230037,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2538,"container":"mp4","duration":6194042,"has64bitOffsets":false,"height":800,"id":14954,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6244271,"file":"/movies/Frozen II (2019)/Frozen II (2019) WEBRip-1080p.mp4","has64bitOffsets":false,"id":14999,"key":"/library/parts/14999/1629001526/file.mp4","optimizedForStreaming":true,"size":1983357282,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2536,"container":"mp4","duration":6244271,"has64bitOffsets":false,"height":800,"id":14999,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Idina Menzel"},{"tag":"Kristen Bell"},{"tag":"Josh Gad"}],"Writer":[{"tag":"Chris Buck"},{"tag":"Hans Christian Andersen"}],"addedAt":1588207762,"art":"/library/metadata/5858/art/1704621922","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6194042,"guid":"plex://movie/5d776b85594b2b001e6dc641","key":"/library/metadata/5858","lastViewedAt":1705337663,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2019-11-20T00:00:00Z","primaryExtraKey":"/library/metadata/5892","rating":7.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"5858","skipCount":1,"studio":"Walt Disney Pictures","summary":"Anna, Elsa, Kristoff, Olaf and Sven leave Arendelle to travel to an ancient, autumn-bound forest of an enchanted land. They set out to find the origin of Elsa's powers in order to save their kingdom.","tagline":"The past is not what it seems.","thumb":"/library/metadata/5858/thumb/1704621922","title":"Frozen II","type":"movie","updatedAt":1704621922,"viewCount":1,"year":2019},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}],"context":"hub.movie.recentlyviewed","hubIdentifier":"movie.recentlyviewed.1","hubKey":"/library/metadata/66485,66098,57249,11449,5858,14944","key":"/library/sections/1/all?sort=lastViewedAt:desc\u0026unwatched=0\u0026viewOffset=0","more":true,"promoted":true,"random":true,"size":6,"style":"shelf","title":"Recently Played Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_hubs_hub/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_metadata/go.mdx b/content/types/models/operations/get_library_hubs_metadata/go.mdx new file mode 100644 index 0000000..3b94ad5 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_metadata/go.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `RatingKey` *{`*string`}* +
+**Example:** `14944` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/14944` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://movie/5d77686eeb5d26001f1eb339` + +--- +##### `Studio` *{`*string`}* +
+**Example:** `Walt Disney Animation Studios` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Tangled` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionKey` *{`*string`}* +
+**Example:** `/library/sections/1` + +--- +##### `ContentRating` *{`*string`}* +
+**Example:** `PG` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.` + +--- +##### `Rating` *{`*float64`}* +
+**Example:** `8.9` + +--- +##### `AudienceRating` *{`*float64`}* +
+**Example:** `8.7` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1704936047` + +--- +##### `Year` *{`*int`}* +
+**Example:** `2010` + +--- +##### `Tagline` *{`*string`}* +
+**Example:** `They're taking adventure to new lengths.` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/14944/thumb/1705739847` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/14944/art/1705739847` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `6017237` + +--- +##### `OriginallyAvailableAt` *{`*types.Date`}* +
+**Example:** `2010-11-24 00:00:00 +0000 UTC` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1589412494` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705739847` + +--- +##### `AudienceRatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `PrimaryExtraKey` *{`*string`}* +
+**Example:** `/library/metadata/14952` + +--- +##### `RatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `Media` *{`[]operations.GetLibraryHubsMedia`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_library_hubs_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Genre` *{`[]operations.GetLibraryHubsGenre`}* +
+**Example:** `[{"tag":"Animation"}]` + + import('/content/types/models/operations/get_library_hubs_genre/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Country` *{`[]operations.GetLibraryHubsCountry`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_hubs_country/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Director` *{`[]operations.GetLibraryHubsDirector`}* +
+**Example:** `[{"tag":"Nathan Greno"}]` + + import('/content/types/models/operations/get_library_hubs_director/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Role` *{`[]operations.GetLibraryHubsRole`}* +
+**Example:** `[{"tag":"Donna Murphy"}]` + + import('/content/types/models/operations/get_library_hubs_role/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Writer` *{`[]operations.GetLibraryHubsWriter`}* +
+**Example:** `[{"tag":"Wilhelm Grimm"}]` + + import('/content/types/models/operations/get_library_hubs_writer/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `SkipCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `ChapterSource` *{`*string`}* +
+**Example:** `media` + + diff --git a/content/types/models/operations/get_library_hubs_metadata/python.mdx b/content/types/models/operations/get_library_hubs_metadata/python.mdx new file mode 100644 index 0000000..b6b7817 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_metadata/python.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `14944` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/14944` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://movie/5d77686eeb5d26001f1eb339` + +--- +##### `studio` *{`Optional[str]`}* +
+**Example:** `Walt Disney Animation Studios` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Tangled` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1` + +--- +##### `content_rating` *{`Optional[str]`}* +
+**Example:** `PG` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.` + +--- +##### `rating` *{`Optional[float]`}* +
+**Example:** `8.9` + +--- +##### `audience_rating` *{`Optional[float]`}* +
+**Example:** `8.7` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1704936047` + +--- +##### `year` *{`Optional[int]`}* +
+**Example:** `2010` + +--- +##### `tagline` *{`Optional[str]`}* +
+**Example:** `They're taking adventure to new lengths.` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/14944/thumb/1705739847` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/14944/art/1705739847` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `6017237` + +--- +##### `originally_available_at` [*{ `datetime` }*](https://docs.python.org/3/library/datetime.html#datetime-objects) +
+**Example:** `2010-11-24 00:00:00 +0000 UTC` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1589412494` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705739847` + +--- +##### `audience_rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `primary_extra_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/14952` + +--- +##### `rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` *{`List[operations.GetLibraryHubsMedia]`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_library_hubs_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre` *{`List[operations.GetLibraryHubsGenre]`}* +
+**Example:** `[{"tag":"Animation"}]` + + import('/content/types/models/operations/get_library_hubs_genre/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country` *{`List[operations.GetLibraryHubsCountry]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_hubs_country/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director` *{`List[operations.GetLibraryHubsDirector]`}* +
+**Example:** `[{"tag":"Nathan Greno"}]` + + import('/content/types/models/operations/get_library_hubs_director/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role` *{`List[operations.GetLibraryHubsRole]`}* +
+**Example:** `[{"tag":"Donna Murphy"}]` + + import('/content/types/models/operations/get_library_hubs_role/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer` *{`List[operations.GetLibraryHubsWriter]`}* +
+**Example:** `[{"tag":"Wilhelm Grimm"}]` + + import('/content/types/models/operations/get_library_hubs_writer/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `skip_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `chapter_source` *{`Optional[str]`}* +
+**Example:** `media` + + diff --git a/content/types/models/operations/get_library_hubs_metadata/typescript.mdx b/content/types/models/operations/get_library_hubs_metadata/typescript.mdx new file mode 100644 index 0000000..857b398 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_metadata/typescript.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ratingKey?`: *{`string`}* +
+**Example:** `14944` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/14944` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://movie/5d77686eeb5d26001f1eb339` + +--- +##### `studio?`: *{`string`}* +
+**Example:** `Walt Disney Animation Studios` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Tangled` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionKey?`: *{`string`}* +
+**Example:** `/library/sections/1` + +--- +##### `contentRating?`: *{`string`}* +
+**Example:** `PG` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.` + +--- +##### `rating?`: *{`number`}* +
+**Example:** `8.9` + +--- +##### `audienceRating?`: *{`number`}* +
+**Example:** `8.7` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1704936047` + +--- +##### `year?`: *{`number`}* +
+**Example:** `2010` + +--- +##### `tagline?`: *{`string`}* +
+**Example:** `They're taking adventure to new lengths.` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/14944/thumb/1705739847` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/14944/art/1705739847` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `6017237` + +--- +##### `originallyAvailableAt?`: *{`RFCDate`}* +
+**Example:** `2010-11-24 00:00:00 +0000 UTC` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1589412494` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705739847` + +--- +##### `audienceRatingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `primaryExtraKey?`: *{`string`}* +
+**Example:** `/library/metadata/14952` + +--- +##### `ratingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media?`: *{`operations.GetLibraryHubsMedia[]`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_library_hubs_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre?`: *{`operations.GetLibraryHubsGenre[]`}* +
+**Example:** `[{"tag":"Animation"}]` + + import('/content/types/models/operations/get_library_hubs_genre/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country?`: *{`operations.GetLibraryHubsCountry[]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_hubs_country/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director?`: *{`operations.GetLibraryHubsDirector[]`}* +
+**Example:** `[{"tag":"Nathan Greno"}]` + + import('/content/types/models/operations/get_library_hubs_director/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role?`: *{`operations.GetLibraryHubsRole[]`}* +
+**Example:** `[{"tag":"Donna Murphy"}]` + + import('/content/types/models/operations/get_library_hubs_role/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer?`: *{`operations.GetLibraryHubsWriter[]`}* +
+**Example:** `[{"tag":"Wilhelm Grimm"}]` + + import('/content/types/models/operations/get_library_hubs_writer/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `skipCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `chapterSource?`: *{`string`}* +
+**Example:** `media` + + diff --git a/content/types/models/operations/get_library_hubs_part/go.mdx b/content/types/models/operations/get_library_hubs_part/go.mdx new file mode 100644 index 0000000..527f374 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_part/go.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `38247` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/parts/38247/1589412494/file.mp4` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `6017237` + +--- +##### `File` *{`*string`}* +
+**Example:** `/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4` + +--- +##### `Size` *{`*int`}* +
+**Example:** `1545647447` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `OptimizedForStreaming` *{`*bool`}* +
+**Example:** `true` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_library_hubs_part/python.mdx b/content/types/models/operations/get_library_hubs_part/python.mdx new file mode 100644 index 0000000..b2e31b5 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_part/python.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `38247` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/parts/38247/1589412494/file.mp4` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `6017237` + +--- +##### `file` *{`Optional[str]`}* +
+**Example:** `/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `1545647447` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `optimized_for_streaming` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_library_hubs_part/typescript.mdx b/content/types/models/operations/get_library_hubs_part/typescript.mdx new file mode 100644 index 0000000..b92a2d4 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_part/typescript.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `38247` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/parts/38247/1589412494/file.mp4` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `6017237` + +--- +##### `file?`: *{`string`}* +
+**Example:** `/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4` + +--- +##### `size?`: *{`number`}* +
+**Example:** `1545647447` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `optimizedForStreaming?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_library_hubs_response/go.mdx b/content/types/models/operations/get_library_hubs_response/go.mdx index 3b4ae5c..cc4c900 100644 --- a/content/types/models/operations/get_library_hubs_response/go.mdx +++ b/content/types/models/operations/get_library_hubs_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetLibraryHubsResponseBody`}* +The hubs specific to the library + + import('/content/types/models/operations/get_library_hubs_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_hubs_response/python.mdx b/content/types/models/operations/get_library_hubs_response/python.mdx index 93ee0a0..70fd705 100644 --- a/content/types/models/operations/get_library_hubs_response/python.mdx +++ b/content/types/models/operations/get_library_hubs_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetLibraryHubsResponseBody]`}* +The hubs specific to the library + + import('/content/types/models/operations/get_library_hubs_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_hubs_response/typescript.mdx b/content/types/models/operations/get_library_hubs_response/typescript.mdx index 2035a36..99c4c3a 100644 --- a/content/types/models/operations/get_library_hubs_response/typescript.mdx +++ b/content/types/models/operations/get_library_hubs_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetLibraryHubsResponseBody`}* +The hubs specific to the library + + import('/content/types/models/operations/get_library_hubs_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_hubs_response_body/go.mdx b/content/types/models/operations/get_library_hubs_response_body/go.mdx new file mode 100644 index 0000000..a6de1ff --- /dev/null +++ b/content/types/models/operations/get_library_hubs_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetLibraryHubsMediaContainer`}* + + import('/content/types/models/operations/get_library_hubs_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_response_body/python.mdx b/content/types/models/operations/get_library_hubs_response_body/python.mdx new file mode 100644 index 0000000..d38cf08 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetLibraryHubsMediaContainer]`}* + + import('/content/types/models/operations/get_library_hubs_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_response_body/typescript.mdx b/content/types/models/operations/get_library_hubs_response_body/typescript.mdx new file mode 100644 index 0000000..bcbc01a --- /dev/null +++ b/content/types/models/operations/get_library_hubs_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetLibraryHubsMediaContainer`}* + + import('/content/types/models/operations/get_library_hubs_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_hubs_role/go.mdx b/content/types/models/operations/get_library_hubs_role/go.mdx new file mode 100644 index 0000000..d635cf7 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_role/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Donna Murphy` + + diff --git a/content/types/models/operations/get_library_hubs_role/python.mdx b/content/types/models/operations/get_library_hubs_role/python.mdx new file mode 100644 index 0000000..a408094 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_role/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Donna Murphy` + + diff --git a/content/types/models/operations/get_library_hubs_role/typescript.mdx b/content/types/models/operations/get_library_hubs_role/typescript.mdx new file mode 100644 index 0000000..503c00b --- /dev/null +++ b/content/types/models/operations/get_library_hubs_role/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Donna Murphy` + + diff --git a/content/types/models/operations/get_library_hubs_writer/go.mdx b/content/types/models/operations/get_library_hubs_writer/go.mdx new file mode 100644 index 0000000..11a3300 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_writer/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Wilhelm Grimm` + + diff --git a/content/types/models/operations/get_library_hubs_writer/python.mdx b/content/types/models/operations/get_library_hubs_writer/python.mdx new file mode 100644 index 0000000..d811d5b --- /dev/null +++ b/content/types/models/operations/get_library_hubs_writer/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Wilhelm Grimm` + + diff --git a/content/types/models/operations/get_library_hubs_writer/typescript.mdx b/content/types/models/operations/get_library_hubs_writer/typescript.mdx new file mode 100644 index 0000000..39419e4 --- /dev/null +++ b/content/types/models/operations/get_library_hubs_writer/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Wilhelm Grimm` + + diff --git a/content/types/models/operations/get_library_items_country/go.mdx b/content/types/models/operations/get_library_items_country/go.mdx new file mode 100644 index 0000000..325b7e8 --- /dev/null +++ b/content/types/models/operations/get_library_items_country/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_items_country/python.mdx b/content/types/models/operations/get_library_items_country/python.mdx new file mode 100644 index 0000000..437d086 --- /dev/null +++ b/content/types/models/operations/get_library_items_country/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_items_country/typescript.mdx b/content/types/models/operations/get_library_items_country/typescript.mdx new file mode 100644 index 0000000..53ee7ea --- /dev/null +++ b/content/types/models/operations/get_library_items_country/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_library_items_director/go.mdx b/content/types/models/operations/get_library_items_director/go.mdx new file mode 100644 index 0000000..d095864 --- /dev/null +++ b/content/types/models/operations/get_library_items_director/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_items_director/python.mdx b/content/types/models/operations/get_library_items_director/python.mdx new file mode 100644 index 0000000..c01ce6b --- /dev/null +++ b/content/types/models/operations/get_library_items_director/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_items_director/typescript.mdx b/content/types/models/operations/get_library_items_director/typescript.mdx new file mode 100644 index 0000000..999ff67 --- /dev/null +++ b/content/types/models/operations/get_library_items_director/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_items_genre/go.mdx b/content/types/models/operations/get_library_items_genre/go.mdx new file mode 100644 index 0000000..4fdd8a0 --- /dev/null +++ b/content/types/models/operations/get_library_items_genre/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Adventure` + + diff --git a/content/types/models/operations/get_library_items_genre/python.mdx b/content/types/models/operations/get_library_items_genre/python.mdx new file mode 100644 index 0000000..ffbdd36 --- /dev/null +++ b/content/types/models/operations/get_library_items_genre/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Adventure` + + diff --git a/content/types/models/operations/get_library_items_genre/typescript.mdx b/content/types/models/operations/get_library_items_genre/typescript.mdx new file mode 100644 index 0000000..e47824e --- /dev/null +++ b/content/types/models/operations/get_library_items_genre/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Adventure` + + diff --git a/content/types/models/operations/get_library_items_media/go.mdx b/content/types/models/operations/get_library_items_media/go.mdx new file mode 100644 index 0000000..0c6b732 --- /dev/null +++ b/content/types/models/operations/get_library_items_media/go.mdx @@ -0,0 +1,77 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ID` *{`*int`}* +
+**Example:** `119534` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `11558112` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `25025` + +--- +##### `Width` *{`*int`}* +
+**Example:** `3840` + +--- +##### `Height` *{`*int`}* +
+**Example:** `2072` + +--- +##### `AspectRatio` *{`*float64`}* +
+**Example:** `1.85` + +--- +##### `AudioChannels` *{`*int`}* +
+**Example:** `6` + +--- +##### `AudioCodec` *{`*string`}* +
+**Example:** `eac3` + +--- +##### `VideoCodec` *{`*string`}* +
+**Example:** `hevc` + +--- +##### `VideoResolution` *{`*string`}* +
+**Example:** `4k` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mkv` + +--- +##### `VideoFrameRate` *{`*string`}* +
+**Example:** `24p` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `main 10` + +--- +##### `Part` *{`[]operations.GetLibraryItemsPart`}* +
+**Example:** `[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}]` + + import('/content/types/models/operations/get_library_items_part/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_media/python.mdx b/content/types/models/operations/get_library_items_media/python.mdx new file mode 100644 index 0000000..5d6ed65 --- /dev/null +++ b/content/types/models/operations/get_library_items_media/python.mdx @@ -0,0 +1,77 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id` *{`Optional[int]`}* +
+**Example:** `119534` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `11558112` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `25025` + +--- +##### `width` *{`Optional[int]`}* +
+**Example:** `3840` + +--- +##### `height` *{`Optional[int]`}* +
+**Example:** `2072` + +--- +##### `aspect_ratio` *{`Optional[float]`}* +
+**Example:** `1.85` + +--- +##### `audio_channels` *{`Optional[int]`}* +
+**Example:** `6` + +--- +##### `audio_codec` *{`Optional[str]`}* +
+**Example:** `eac3` + +--- +##### `video_codec` *{`Optional[str]`}* +
+**Example:** `hevc` + +--- +##### `video_resolution` *{`Optional[str]`}* +
+**Example:** `4k` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mkv` + +--- +##### `video_frame_rate` *{`Optional[str]`}* +
+**Example:** `24p` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `main 10` + +--- +##### `part` *{`List[operations.GetLibraryItemsPart]`}* +
+**Example:** `[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}]` + + import('/content/types/models/operations/get_library_items_part/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_media/typescript.mdx b/content/types/models/operations/get_library_items_media/typescript.mdx new file mode 100644 index 0000000..db9b593 --- /dev/null +++ b/content/types/models/operations/get_library_items_media/typescript.mdx @@ -0,0 +1,77 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id?`: *{`number`}* +
+**Example:** `119534` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `11558112` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `25025` + +--- +##### `width?`: *{`number`}* +
+**Example:** `3840` + +--- +##### `height?`: *{`number`}* +
+**Example:** `2072` + +--- +##### `aspectRatio?`: *{`number`}* +
+**Example:** `1.85` + +--- +##### `audioChannels?`: *{`number`}* +
+**Example:** `6` + +--- +##### `audioCodec?`: *{`string`}* +
+**Example:** `eac3` + +--- +##### `videoCodec?`: *{`string`}* +
+**Example:** `hevc` + +--- +##### `videoResolution?`: *{`string`}* +
+**Example:** `4k` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mkv` + +--- +##### `videoFrameRate?`: *{`string`}* +
+**Example:** `24p` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `main 10` + +--- +##### `part?`: *{`operations.GetLibraryItemsPart[]`}* +
+**Example:** `[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}]` + + import('/content/types/models/operations/get_library_items_part/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_media_container/go.mdx b/content/types/models/operations/get_library_items_media_container/go.mdx new file mode 100644 index 0000000..5acc060 --- /dev/null +++ b/content/types/models/operations/get_library_items_media_container/go.mdx @@ -0,0 +1,82 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `70` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionUUID` *{`*string`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `MediaTagPrefix` *{`*string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `MediaTagVersion` *{`*int`}* +
+**Example:** `1701731894` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `Title1` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `Title2` *{`*string`}* +
+**Example:** `Recently Released` + +--- +##### `ViewGroup` *{`*string`}* +
+**Example:** `movie` + +--- +##### `ViewMode` *{`*int`}* +
+**Example:** `65592` + +--- +##### `Metadata` *{`[]operations.GetLibraryItemsMetadata`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` + + import('/content/types/models/operations/get_library_items_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_media_container/python.mdx b/content/types/models/operations/get_library_items_media_container/python.mdx new file mode 100644 index 0000000..3ce90aa --- /dev/null +++ b/content/types/models/operations/get_library_items_media_container/python.mdx @@ -0,0 +1,82 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `70` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_uuid` *{`Optional[str]`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `media_tag_prefix` *{`Optional[str]`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `media_tag_version` *{`Optional[int]`}* +
+**Example:** `1701731894` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `title2` *{`Optional[str]`}* +
+**Example:** `Recently Released` + +--- +##### `view_group` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `view_mode` *{`Optional[int]`}* +
+**Example:** `65592` + +--- +##### `metadata` *{`List[operations.GetLibraryItemsMetadata]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` + + import('/content/types/models/operations/get_library_items_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_media_container/typescript.mdx b/content/types/models/operations/get_library_items_media_container/typescript.mdx new file mode 100644 index 0000000..b8912d2 --- /dev/null +++ b/content/types/models/operations/get_library_items_media_container/typescript.mdx @@ -0,0 +1,82 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `70` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionUUID?`: *{`string`}* +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `mediaTagPrefix?`: *{`string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion?`: *{`number`}* +
+**Example:** `1701731894` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `title2?`: *{`string`}* +
+**Example:** `Recently Released` + +--- +##### `viewGroup?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `viewMode?`: *{`number`}* +
+**Example:** `65592` + +--- +##### `metadata?`: *{`operations.GetLibraryItemsMetadata[]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` + + import('/content/types/models/operations/get_library_items_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_metadata/go.mdx b/content/types/models/operations/get_library_items_metadata/go.mdx new file mode 100644 index 0000000..43160dc --- /dev/null +++ b/content/types/models/operations/get_library_items_metadata/go.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `RatingKey` *{`*string`}* +
+**Example:** `58683` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/58683` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://movie/5d7768ba96b655001fdc0408` + +--- +##### `Studio` *{`*string`}* +
+**Example:** `20th Century Studios` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Avatar: The Way of Water` + +--- +##### `ContentRating` *{`*string`}* +
+**Example:** `PG-13` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.` + +--- +##### `Rating` *{`*float64`}* +
+**Example:** `7.6` + +--- +##### `AudienceRating` *{`*float64`}* +
+**Example:** `9.2` + +--- +##### `Year` *{`*int`}* +
+**Example:** `2022` + +--- +##### `Tagline` *{`*string`}* +
+**Example:** `Return to Pandora.` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/58683/thumb/1703239236` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/58683/art/1703239236` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `11558112` + +--- +##### `OriginallyAvailableAt` *{`*types.Date`}* +
+**Example:** `2022-12-14 00:00:00 +0000 UTC` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1680457607` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1703239236` + +--- +##### `AudienceRatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `ChapterSource` *{`*string`}* +
+**Example:** `media` + +--- +##### `PrimaryExtraKey` *{`*string`}* +
+**Example:** `/library/metadata/58684` + +--- +##### `RatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `Media` *{`[]operations.GetLibraryItemsMedia`}* +
+**Example:** `[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}]` + + import('/content/types/models/operations/get_library_items_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Genre` *{`[]operations.GetLibraryItemsGenre`}* +
+**Example:** `[{"tag":"Adventure"}]` + + import('/content/types/models/operations/get_library_items_genre/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Country` *{`[]operations.GetLibraryItemsCountry`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_items_country/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Director` *{`[]operations.GetLibraryItemsDirector`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_director/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Writer` *{`[]operations.GetLibraryItemsWriter`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_writer/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Role` *{`[]operations.GetLibraryItemsRole`}* +
+**Example:** `[{"tag":"Sigourney Weaver"}]` + + import('/content/types/models/operations/get_library_items_role/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `TitleSort` *{`*string`}* +
+**Example:** `Whale` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1682752242` + +--- +##### `OriginalTitle` *{`*string`}* +
+**Example:** `映画 ブラッククローバー 魔法帝の剣` + +--- +##### `ViewOffset` *{`*int`}* +
+**Example:** `5222500` + +--- +##### `SkipCount` *{`*int`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/get_library_items_metadata/python.mdx b/content/types/models/operations/get_library_items_metadata/python.mdx new file mode 100644 index 0000000..b22dc5e --- /dev/null +++ b/content/types/models/operations/get_library_items_metadata/python.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `58683` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/58683` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://movie/5d7768ba96b655001fdc0408` + +--- +##### `studio` *{`Optional[str]`}* +
+**Example:** `20th Century Studios` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Avatar: The Way of Water` + +--- +##### `content_rating` *{`Optional[str]`}* +
+**Example:** `PG-13` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.` + +--- +##### `rating` *{`Optional[float]`}* +
+**Example:** `7.6` + +--- +##### `audience_rating` *{`Optional[float]`}* +
+**Example:** `9.2` + +--- +##### `year` *{`Optional[int]`}* +
+**Example:** `2022` + +--- +##### `tagline` *{`Optional[str]`}* +
+**Example:** `Return to Pandora.` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/58683/thumb/1703239236` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/58683/art/1703239236` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `11558112` + +--- +##### `originally_available_at` [*{ `datetime` }*](https://docs.python.org/3/library/datetime.html#datetime-objects) +
+**Example:** `2022-12-14 00:00:00 +0000 UTC` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1680457607` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1703239236` + +--- +##### `audience_rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `chapter_source` *{`Optional[str]`}* +
+**Example:** `media` + +--- +##### `primary_extra_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/58684` + +--- +##### `rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` *{`List[operations.GetLibraryItemsMedia]`}* +
+**Example:** `[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}]` + + import('/content/types/models/operations/get_library_items_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre` *{`List[operations.GetLibraryItemsGenre]`}* +
+**Example:** `[{"tag":"Adventure"}]` + + import('/content/types/models/operations/get_library_items_genre/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country` *{`List[operations.GetLibraryItemsCountry]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_items_country/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director` *{`List[operations.GetLibraryItemsDirector]`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_director/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer` *{`List[operations.GetLibraryItemsWriter]`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_writer/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role` *{`List[operations.GetLibraryItemsRole]`}* +
+**Example:** `[{"tag":"Sigourney Weaver"}]` + + import('/content/types/models/operations/get_library_items_role/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `title_sort` *{`Optional[str]`}* +
+**Example:** `Whale` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1682752242` + +--- +##### `original_title` *{`Optional[str]`}* +
+**Example:** `映画 ブラッククローバー 魔法帝の剣` + +--- +##### `view_offset` *{`Optional[int]`}* +
+**Example:** `5222500` + +--- +##### `skip_count` *{`Optional[int]`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/get_library_items_metadata/typescript.mdx b/content/types/models/operations/get_library_items_metadata/typescript.mdx new file mode 100644 index 0000000..d15ef0f --- /dev/null +++ b/content/types/models/operations/get_library_items_metadata/typescript.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ratingKey?`: *{`string`}* +
+**Example:** `58683` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/58683` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://movie/5d7768ba96b655001fdc0408` + +--- +##### `studio?`: *{`string`}* +
+**Example:** `20th Century Studios` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Avatar: The Way of Water` + +--- +##### `contentRating?`: *{`string`}* +
+**Example:** `PG-13` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.` + +--- +##### `rating?`: *{`number`}* +
+**Example:** `7.6` + +--- +##### `audienceRating?`: *{`number`}* +
+**Example:** `9.2` + +--- +##### `year?`: *{`number`}* +
+**Example:** `2022` + +--- +##### `tagline?`: *{`string`}* +
+**Example:** `Return to Pandora.` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/58683/thumb/1703239236` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/58683/art/1703239236` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `11558112` + +--- +##### `originallyAvailableAt?`: *{`RFCDate`}* +
+**Example:** `2022-12-14 00:00:00 +0000 UTC` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1680457607` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1703239236` + +--- +##### `audienceRatingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `chapterSource?`: *{`string`}* +
+**Example:** `media` + +--- +##### `primaryExtraKey?`: *{`string`}* +
+**Example:** `/library/metadata/58684` + +--- +##### `ratingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media?`: *{`operations.GetLibraryItemsMedia[]`}* +
+**Example:** `[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}]` + + import('/content/types/models/operations/get_library_items_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre?`: *{`operations.GetLibraryItemsGenre[]`}* +
+**Example:** `[{"tag":"Adventure"}]` + + import('/content/types/models/operations/get_library_items_genre/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country?`: *{`operations.GetLibraryItemsCountry[]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_library_items_country/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director?`: *{`operations.GetLibraryItemsDirector[]`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_director/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer?`: *{`operations.GetLibraryItemsWriter[]`}* +
+**Example:** `[{"tag":"James Cameron"}]` + + import('/content/types/models/operations/get_library_items_writer/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role?`: *{`operations.GetLibraryItemsRole[]`}* +
+**Example:** `[{"tag":"Sigourney Weaver"}]` + + import('/content/types/models/operations/get_library_items_role/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `titleSort?`: *{`string`}* +
+**Example:** `Whale` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1682752242` + +--- +##### `originalTitle?`: *{`string`}* +
+**Example:** `映画 ブラッククローバー 魔法帝の剣` + +--- +##### `viewOffset?`: *{`number`}* +
+**Example:** `5222500` + +--- +##### `skipCount?`: *{`number`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/get_library_items_part/go.mdx b/content/types/models/operations/get_library_items_part/go.mdx new file mode 100644 index 0000000..ac761f9 --- /dev/null +++ b/content/types/models/operations/get_library_items_part/go.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `119542` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/parts/119542/1680457526/file.mkv` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `11558112` + +--- +##### `File` *{`*string`}* +
+**Example:** `/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv` + +--- +##### `Size` *{`*int64`}* +
+**Example:** `36158371307` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mkv` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `main 10` + + diff --git a/content/types/models/operations/get_library_items_part/python.mdx b/content/types/models/operations/get_library_items_part/python.mdx new file mode 100644 index 0000000..6df3b5c --- /dev/null +++ b/content/types/models/operations/get_library_items_part/python.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `119542` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/parts/119542/1680457526/file.mkv` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `11558112` + +--- +##### `file` *{`Optional[str]`}* +
+**Example:** `/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `36158371307` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mkv` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `main 10` + + diff --git a/content/types/models/operations/get_library_items_part/typescript.mdx b/content/types/models/operations/get_library_items_part/typescript.mdx new file mode 100644 index 0000000..f2c4c55 --- /dev/null +++ b/content/types/models/operations/get_library_items_part/typescript.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `119542` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/parts/119542/1680457526/file.mkv` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `11558112` + +--- +##### `file?`: *{`string`}* +
+**Example:** `/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv` + +--- +##### `size?`: *{`number`}* +
+**Example:** `36158371307` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mkv` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `main 10` + + diff --git a/content/types/models/operations/get_library_items_request/go.mdx b/content/types/models/operations/get_library_items_request/go.mdx index 6fe6d50..1bfe95b 100644 --- a/content/types/models/operations/get_library_items_request/go.mdx +++ b/content/types/models/operations/get_library_items_request/go.mdx @@ -1,13 +1,15 @@ {/* Autogenerated DO NOT EDIT */} -##### `SectionID` *{`float64`}* +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `SectionID` *{`int64`}* the Id of the library to query --- -##### `Type` *{`*float64`}* -item type +##### `Tag` *{`operations.Tag`}* +A key representing a specific tag within the section. + + import('/content/types/models/operations/tag/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> ---- -##### `Filter` *{`*string`}* -the filter parameter diff --git a/content/types/models/operations/get_library_items_request/python.mdx b/content/types/models/operations/get_library_items_request/python.mdx index 53f24e9..fae7dda 100644 --- a/content/types/models/operations/get_library_items_request/python.mdx +++ b/content/types/models/operations/get_library_items_request/python.mdx @@ -1,13 +1,15 @@ {/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* the Id of the library to query --- -##### `type` *{`Optional[float]`}* -item type +##### `tag` *{`operations.Tag`}* +A key representing a specific tag within the section. + + import('/content/types/models/operations/tag/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter diff --git a/content/types/models/operations/get_library_items_request/typescript.mdx b/content/types/models/operations/get_library_items_request/typescript.mdx index a03d7e9..f83fb0d 100644 --- a/content/types/models/operations/get_library_items_request/typescript.mdx +++ b/content/types/models/operations/get_library_items_request/typescript.mdx @@ -1,13 +1,15 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `sectionId`: *{`number`}* the Id of the library to query --- -##### `type?`: *{`number`}* -item type +##### `tag`: *{`operations.Tag`}* +A key representing a specific tag within the section. + + import('/content/types/models/operations/tag/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> ---- -##### `filter?`: *{`string`}* -the filter parameter diff --git a/content/types/models/operations/get_library_items_response/go.mdx b/content/types/models/operations/get_library_items_response/go.mdx index 3b4ae5c..ba76d1a 100644 --- a/content/types/models/operations/get_library_items_response/go.mdx +++ b/content/types/models/operations/get_library_items_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetLibraryItemsResponseBody`}* +The contents of the library by section and tag + + import('/content/types/models/operations/get_library_items_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_items_response/python.mdx b/content/types/models/operations/get_library_items_response/python.mdx index 93ee0a0..31fabc4 100644 --- a/content/types/models/operations/get_library_items_response/python.mdx +++ b/content/types/models/operations/get_library_items_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetLibraryItemsResponseBody]`}* +The contents of the library by section and tag + + import('/content/types/models/operations/get_library_items_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_items_response/typescript.mdx b/content/types/models/operations/get_library_items_response/typescript.mdx index 2035a36..90aded3 100644 --- a/content/types/models/operations/get_library_items_response/typescript.mdx +++ b/content/types/models/operations/get_library_items_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetLibraryItemsResponseBody`}* +The contents of the library by section and tag + + import('/content/types/models/operations/get_library_items_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_items_response_body/go.mdx b/content/types/models/operations/get_library_items_response_body/go.mdx new file mode 100644 index 0000000..c39c07c --- /dev/null +++ b/content/types/models/operations/get_library_items_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetLibraryItemsMediaContainer`}* + + import('/content/types/models/operations/get_library_items_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_response_body/python.mdx b/content/types/models/operations/get_library_items_response_body/python.mdx new file mode 100644 index 0000000..1d605fa --- /dev/null +++ b/content/types/models/operations/get_library_items_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetLibraryItemsMediaContainer]`}* + + import('/content/types/models/operations/get_library_items_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_response_body/typescript.mdx b/content/types/models/operations/get_library_items_response_body/typescript.mdx new file mode 100644 index 0000000..127622c --- /dev/null +++ b/content/types/models/operations/get_library_items_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetLibraryItemsMediaContainer`}* + + import('/content/types/models/operations/get_library_items_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_items_role/go.mdx b/content/types/models/operations/get_library_items_role/go.mdx new file mode 100644 index 0000000..29374cf --- /dev/null +++ b/content/types/models/operations/get_library_items_role/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Sigourney Weaver` + + diff --git a/content/types/models/operations/get_library_items_role/python.mdx b/content/types/models/operations/get_library_items_role/python.mdx new file mode 100644 index 0000000..df3e6f8 --- /dev/null +++ b/content/types/models/operations/get_library_items_role/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Sigourney Weaver` + + diff --git a/content/types/models/operations/get_library_items_role/typescript.mdx b/content/types/models/operations/get_library_items_role/typescript.mdx new file mode 100644 index 0000000..3bf0924 --- /dev/null +++ b/content/types/models/operations/get_library_items_role/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Sigourney Weaver` + + diff --git a/content/types/models/operations/get_library_items_writer/go.mdx b/content/types/models/operations/get_library_items_writer/go.mdx new file mode 100644 index 0000000..d095864 --- /dev/null +++ b/content/types/models/operations/get_library_items_writer/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_items_writer/python.mdx b/content/types/models/operations/get_library_items_writer/python.mdx new file mode 100644 index 0000000..c01ce6b --- /dev/null +++ b/content/types/models/operations/get_library_items_writer/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_items_writer/typescript.mdx b/content/types/models/operations/get_library_items_writer/typescript.mdx new file mode 100644 index 0000000..999ff67 --- /dev/null +++ b/content/types/models/operations/get_library_items_writer/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `James Cameron` + + diff --git a/content/types/models/operations/get_library_media_container/go.mdx b/content/types/models/operations/get_library_media_container/go.mdx new file mode 100644 index 0000000..f76d429 --- /dev/null +++ b/content/types/models/operations/get_library_media_container/go.mdx @@ -0,0 +1,88 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `29` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `Content` *{`*string`}* +
+**Example:** `secondary` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `MediaTagPrefix` *{`*string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `MediaTagVersion` *{`*int`}* +
+**Example:** `1701731894` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `Title1` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `ViewGroup` *{`*string`}* +
+**Example:** `secondary` + +--- +##### `ViewMode` *{`*int`}* +
+**Example:** `65592` + +--- +##### `Directory` *{`[]operations.GetLibraryDirectory`}* +
+**Example:** `[{"key":"search?type=1","prompt":"Search Movies","search":true,"secondary":true,"title":"Search..."}]` + + import('/content/types/models/operations/get_library_directory/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Type` *{`[]operations.GetLibraryType`}* +
+**Example:** `[{"Field":[{"key":"title","title":"Title","type":"string"},{"key":"studio","title":"Studio","type":"string"},{"key":"userRating","subType":"rating","title":"Rating","type":"integer"},{"key":"contentRating","title":"Content Rating","type":"tag"},{"key":"year","subType":"year","title":"Year","type":"integer"},{"key":"decade","subType":"decade","title":"Decade","type":"integer"},{"key":"originallyAvailableAt","title":"Release Date","type":"date"},{"key":"duration","subType":"duration","title":"Duration","type":"integer"},{"key":"unmatched","title":"Unmatched","type":"boolean"},{"key":"duplicate","title":"Duplicate","type":"boolean"},{"key":"genre","title":"Genre","type":"tag"},{"key":"collection","title":"Collection","type":"tag"},{"key":"director","title":"Director","type":"tag"},{"key":"writer","title":"Writer","type":"tag"},{"key":"producer","title":"Producer","type":"tag"},{"key":"actor","title":"Actor","type":"tag"},{"key":"country","title":"Country","type":"tag"},{"key":"addedAt","title":"Date Added","type":"date"},{"key":"viewCount","title":"Plays","type":"integer"},{"key":"lastViewedAt","title":"Last Played","type":"date"},{"key":"unwatched","title":"Unplayed","type":"boolean"},{"key":"resolution","title":"Resolution","type":"resolution"},{"key":"hdr","subType":"hdr","title":"HDR","type":"boolean"},{"key":"mediaSize","subType":"fileSize","title":"File Size","type":"integer"},{"key":"mediaBitrate","subType":"bitrate","title":"Bitrate","type":"integer"},{"key":"subtitleLanguage","title":"Subtitle Language","type":"subtitleLanguage"},{"key":"audioLanguage","title":"Audio Language","type":"audioLanguage"},{"key":"inProgress","title":"In Progress","type":"boolean"},{"key":"trash","title":"Trash","type":"boolean"},{"key":"editionTitle","title":"Edition","type":"string"},{"key":"label","title":"Label","type":"tag"}],"Filter":[{"filter":"genre","filterType":"string","key":"/library/sections/1/genre","title":"Genre","type":"filter"},{"filter":"year","filterType":"integer","key":"/library/sections/1/year","title":"Year","type":"filter"},{"filter":"decade","filterType":"integer","key":"/library/sections/1/decade","title":"Decade","type":"filter"},{"filter":"contentRating","filterType":"string","key":"/library/sections/1/contentRating","title":"Content Rating","type":"filter"},{"filter":"collection","filterType":"string","key":"/library/sections/1/collection","title":"Collection","type":"filter"},{"filter":"director","filterType":"string","key":"/library/sections/1/director","title":"Director","type":"filter"},{"filter":"actor","filterType":"string","key":"/library/sections/1/actor","title":"Actor","type":"filter"},{"filter":"writer","filterType":"string","key":"/library/sections/1/writer","title":"Writer","type":"filter"},{"filter":"producer","filterType":"string","key":"/library/sections/1/producer","title":"Producer","type":"filter"},{"filter":"country","filterType":"string","key":"/library/sections/1/country","title":"Country","type":"filter"},{"filter":"studio","filterType":"string","key":"/library/sections/1/studio","title":"Studio","type":"filter"},{"filter":"resolution","filterType":"string","key":"/library/sections/1/resolution","title":"Resolution","type":"filter"},{"filter":"hdr","filterType":"boolean","key":"/library/sections/1/hdr","title":"HDR","type":"filter"},{"filter":"unwatched","filterType":"boolean","key":"/library/sections/1/unwatched","title":"Unplayed","type":"filter"},{"filter":"inProgress","filterType":"boolean","key":"/library/sections/1/inProgress","title":"In Progress","type":"filter"},{"filter":"unmatched","filterType":"boolean","key":"/library/sections/1/unmatched","title":"Unmatched","type":"filter"},{"filter":"audioLanguage","filterType":"string","key":"/library/sections/1/audioLanguage","title":"Audio Language","type":"filter"},{"filter":"subtitleLanguage","filterType":"string","key":"/library/sections/1/subtitleLanguage","title":"Subtitle Language","type":"filter"},{"filter":"editionTitle","filterType":"string","key":"/library/sections/1/editionTitle","title":"Edition","type":"filter"},{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}],"Sort":[{"default":"asc","defaultDirection":"asc","descKey":"titleSort:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"titleSort","title":"Title"},{"defaultDirection":"desc","descKey":"originallyAvailableAt:desc","key":"originallyAvailableAt","title":"Release Date"},{"defaultDirection":"desc","descKey":"rating:desc","key":"rating","title":"Critic Rating"},{"defaultDirection":"desc","descKey":"audienceRating:desc","key":"audienceRating","title":"Audience Rating"},{"defaultDirection":"desc","descKey":"duration:desc","key":"duration","title":"Duration"},{"defaultDirection":"desc","descKey":"addedAt:desc","key":"addedAt","title":"Date Added"},{"defaultDirection":"desc","descKey":"lastViewedAt:desc","key":"lastViewedAt","title":"Date Viewed"},{"defaultDirection":"asc","descKey":"mediaHeight:desc","key":"mediaHeight","title":"Resolution"},{"defaultDirection":"desc","descKey":"random:desc","key":"random","title":"Randomly"}],"active":false,"key":"/library/sections/1/all?type=1","title":"Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `FieldType` *{`[]operations.FieldType`}* +
+**Example:** `[{"Operator":[{"key":"=","title":"is"}],"type":"resolution"}]` + + import('/content/types/models/operations/field_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_media_container/python.mdx b/content/types/models/operations/get_library_media_container/python.mdx new file mode 100644 index 0000000..8699af1 --- /dev/null +++ b/content/types/models/operations/get_library_media_container/python.mdx @@ -0,0 +1,88 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `29` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `content` *{`Optional[str]`}* +
+**Example:** `secondary` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `media_tag_prefix` *{`Optional[str]`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `media_tag_version` *{`Optional[int]`}* +
+**Example:** `1701731894` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `view_group` *{`Optional[str]`}* +
+**Example:** `secondary` + +--- +##### `view_mode` *{`Optional[int]`}* +
+**Example:** `65592` + +--- +##### `directory` *{`List[operations.GetLibraryDirectory]`}* +
+**Example:** `[{"key":"search?type=1","prompt":"Search Movies","search":true,"secondary":true,"title":"Search..."}]` + + import('/content/types/models/operations/get_library_directory/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `type` *{`List[operations.GetLibraryType]`}* +
+**Example:** `[{"Field":[{"key":"title","title":"Title","type":"string"},{"key":"studio","title":"Studio","type":"string"},{"key":"userRating","subType":"rating","title":"Rating","type":"integer"},{"key":"contentRating","title":"Content Rating","type":"tag"},{"key":"year","subType":"year","title":"Year","type":"integer"},{"key":"decade","subType":"decade","title":"Decade","type":"integer"},{"key":"originallyAvailableAt","title":"Release Date","type":"date"},{"key":"duration","subType":"duration","title":"Duration","type":"integer"},{"key":"unmatched","title":"Unmatched","type":"boolean"},{"key":"duplicate","title":"Duplicate","type":"boolean"},{"key":"genre","title":"Genre","type":"tag"},{"key":"collection","title":"Collection","type":"tag"},{"key":"director","title":"Director","type":"tag"},{"key":"writer","title":"Writer","type":"tag"},{"key":"producer","title":"Producer","type":"tag"},{"key":"actor","title":"Actor","type":"tag"},{"key":"country","title":"Country","type":"tag"},{"key":"addedAt","title":"Date Added","type":"date"},{"key":"viewCount","title":"Plays","type":"integer"},{"key":"lastViewedAt","title":"Last Played","type":"date"},{"key":"unwatched","title":"Unplayed","type":"boolean"},{"key":"resolution","title":"Resolution","type":"resolution"},{"key":"hdr","subType":"hdr","title":"HDR","type":"boolean"},{"key":"mediaSize","subType":"fileSize","title":"File Size","type":"integer"},{"key":"mediaBitrate","subType":"bitrate","title":"Bitrate","type":"integer"},{"key":"subtitleLanguage","title":"Subtitle Language","type":"subtitleLanguage"},{"key":"audioLanguage","title":"Audio Language","type":"audioLanguage"},{"key":"inProgress","title":"In Progress","type":"boolean"},{"key":"trash","title":"Trash","type":"boolean"},{"key":"editionTitle","title":"Edition","type":"string"},{"key":"label","title":"Label","type":"tag"}],"Filter":[{"filter":"genre","filterType":"string","key":"/library/sections/1/genre","title":"Genre","type":"filter"},{"filter":"year","filterType":"integer","key":"/library/sections/1/year","title":"Year","type":"filter"},{"filter":"decade","filterType":"integer","key":"/library/sections/1/decade","title":"Decade","type":"filter"},{"filter":"contentRating","filterType":"string","key":"/library/sections/1/contentRating","title":"Content Rating","type":"filter"},{"filter":"collection","filterType":"string","key":"/library/sections/1/collection","title":"Collection","type":"filter"},{"filter":"director","filterType":"string","key":"/library/sections/1/director","title":"Director","type":"filter"},{"filter":"actor","filterType":"string","key":"/library/sections/1/actor","title":"Actor","type":"filter"},{"filter":"writer","filterType":"string","key":"/library/sections/1/writer","title":"Writer","type":"filter"},{"filter":"producer","filterType":"string","key":"/library/sections/1/producer","title":"Producer","type":"filter"},{"filter":"country","filterType":"string","key":"/library/sections/1/country","title":"Country","type":"filter"},{"filter":"studio","filterType":"string","key":"/library/sections/1/studio","title":"Studio","type":"filter"},{"filter":"resolution","filterType":"string","key":"/library/sections/1/resolution","title":"Resolution","type":"filter"},{"filter":"hdr","filterType":"boolean","key":"/library/sections/1/hdr","title":"HDR","type":"filter"},{"filter":"unwatched","filterType":"boolean","key":"/library/sections/1/unwatched","title":"Unplayed","type":"filter"},{"filter":"inProgress","filterType":"boolean","key":"/library/sections/1/inProgress","title":"In Progress","type":"filter"},{"filter":"unmatched","filterType":"boolean","key":"/library/sections/1/unmatched","title":"Unmatched","type":"filter"},{"filter":"audioLanguage","filterType":"string","key":"/library/sections/1/audioLanguage","title":"Audio Language","type":"filter"},{"filter":"subtitleLanguage","filterType":"string","key":"/library/sections/1/subtitleLanguage","title":"Subtitle Language","type":"filter"},{"filter":"editionTitle","filterType":"string","key":"/library/sections/1/editionTitle","title":"Edition","type":"filter"},{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}],"Sort":[{"default":"asc","defaultDirection":"asc","descKey":"titleSort:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"titleSort","title":"Title"},{"defaultDirection":"desc","descKey":"originallyAvailableAt:desc","key":"originallyAvailableAt","title":"Release Date"},{"defaultDirection":"desc","descKey":"rating:desc","key":"rating","title":"Critic Rating"},{"defaultDirection":"desc","descKey":"audienceRating:desc","key":"audienceRating","title":"Audience Rating"},{"defaultDirection":"desc","descKey":"duration:desc","key":"duration","title":"Duration"},{"defaultDirection":"desc","descKey":"addedAt:desc","key":"addedAt","title":"Date Added"},{"defaultDirection":"desc","descKey":"lastViewedAt:desc","key":"lastViewedAt","title":"Date Viewed"},{"defaultDirection":"asc","descKey":"mediaHeight:desc","key":"mediaHeight","title":"Resolution"},{"defaultDirection":"desc","descKey":"random:desc","key":"random","title":"Randomly"}],"active":false,"key":"/library/sections/1/all?type=1","title":"Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `field_type` *{`List[operations.FieldType]`}* +
+**Example:** `[{"Operator":[{"key":"=","title":"is"}],"type":"resolution"}]` + + import('/content/types/models/operations/field_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_media_container/typescript.mdx b/content/types/models/operations/get_library_media_container/typescript.mdx new file mode 100644 index 0000000..eb8f552 --- /dev/null +++ b/content/types/models/operations/get_library_media_container/typescript.mdx @@ -0,0 +1,88 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `29` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `content?`: *{`string`}* +
+**Example:** `secondary` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `mediaTagPrefix?`: *{`string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion?`: *{`number`}* +
+**Example:** `1701731894` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `viewGroup?`: *{`string`}* +
+**Example:** `secondary` + +--- +##### `viewMode?`: *{`number`}* +
+**Example:** `65592` + +--- +##### `directory?`: *{`operations.GetLibraryDirectory[]`}* +
+**Example:** `[{"key":"search?type=1","prompt":"Search Movies","search":true,"secondary":true,"title":"Search..."}]` + + import('/content/types/models/operations/get_library_directory/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `type?`: *{`operations.GetLibraryType[]`}* +
+**Example:** `[{"Field":[{"key":"title","title":"Title","type":"string"},{"key":"studio","title":"Studio","type":"string"},{"key":"userRating","subType":"rating","title":"Rating","type":"integer"},{"key":"contentRating","title":"Content Rating","type":"tag"},{"key":"year","subType":"year","title":"Year","type":"integer"},{"key":"decade","subType":"decade","title":"Decade","type":"integer"},{"key":"originallyAvailableAt","title":"Release Date","type":"date"},{"key":"duration","subType":"duration","title":"Duration","type":"integer"},{"key":"unmatched","title":"Unmatched","type":"boolean"},{"key":"duplicate","title":"Duplicate","type":"boolean"},{"key":"genre","title":"Genre","type":"tag"},{"key":"collection","title":"Collection","type":"tag"},{"key":"director","title":"Director","type":"tag"},{"key":"writer","title":"Writer","type":"tag"},{"key":"producer","title":"Producer","type":"tag"},{"key":"actor","title":"Actor","type":"tag"},{"key":"country","title":"Country","type":"tag"},{"key":"addedAt","title":"Date Added","type":"date"},{"key":"viewCount","title":"Plays","type":"integer"},{"key":"lastViewedAt","title":"Last Played","type":"date"},{"key":"unwatched","title":"Unplayed","type":"boolean"},{"key":"resolution","title":"Resolution","type":"resolution"},{"key":"hdr","subType":"hdr","title":"HDR","type":"boolean"},{"key":"mediaSize","subType":"fileSize","title":"File Size","type":"integer"},{"key":"mediaBitrate","subType":"bitrate","title":"Bitrate","type":"integer"},{"key":"subtitleLanguage","title":"Subtitle Language","type":"subtitleLanguage"},{"key":"audioLanguage","title":"Audio Language","type":"audioLanguage"},{"key":"inProgress","title":"In Progress","type":"boolean"},{"key":"trash","title":"Trash","type":"boolean"},{"key":"editionTitle","title":"Edition","type":"string"},{"key":"label","title":"Label","type":"tag"}],"Filter":[{"filter":"genre","filterType":"string","key":"/library/sections/1/genre","title":"Genre","type":"filter"},{"filter":"year","filterType":"integer","key":"/library/sections/1/year","title":"Year","type":"filter"},{"filter":"decade","filterType":"integer","key":"/library/sections/1/decade","title":"Decade","type":"filter"},{"filter":"contentRating","filterType":"string","key":"/library/sections/1/contentRating","title":"Content Rating","type":"filter"},{"filter":"collection","filterType":"string","key":"/library/sections/1/collection","title":"Collection","type":"filter"},{"filter":"director","filterType":"string","key":"/library/sections/1/director","title":"Director","type":"filter"},{"filter":"actor","filterType":"string","key":"/library/sections/1/actor","title":"Actor","type":"filter"},{"filter":"writer","filterType":"string","key":"/library/sections/1/writer","title":"Writer","type":"filter"},{"filter":"producer","filterType":"string","key":"/library/sections/1/producer","title":"Producer","type":"filter"},{"filter":"country","filterType":"string","key":"/library/sections/1/country","title":"Country","type":"filter"},{"filter":"studio","filterType":"string","key":"/library/sections/1/studio","title":"Studio","type":"filter"},{"filter":"resolution","filterType":"string","key":"/library/sections/1/resolution","title":"Resolution","type":"filter"},{"filter":"hdr","filterType":"boolean","key":"/library/sections/1/hdr","title":"HDR","type":"filter"},{"filter":"unwatched","filterType":"boolean","key":"/library/sections/1/unwatched","title":"Unplayed","type":"filter"},{"filter":"inProgress","filterType":"boolean","key":"/library/sections/1/inProgress","title":"In Progress","type":"filter"},{"filter":"unmatched","filterType":"boolean","key":"/library/sections/1/unmatched","title":"Unmatched","type":"filter"},{"filter":"audioLanguage","filterType":"string","key":"/library/sections/1/audioLanguage","title":"Audio Language","type":"filter"},{"filter":"subtitleLanguage","filterType":"string","key":"/library/sections/1/subtitleLanguage","title":"Subtitle Language","type":"filter"},{"filter":"editionTitle","filterType":"string","key":"/library/sections/1/editionTitle","title":"Edition","type":"filter"},{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}],"Sort":[{"default":"asc","defaultDirection":"asc","descKey":"titleSort:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"titleSort","title":"Title"},{"defaultDirection":"desc","descKey":"originallyAvailableAt:desc","key":"originallyAvailableAt","title":"Release Date"},{"defaultDirection":"desc","descKey":"rating:desc","key":"rating","title":"Critic Rating"},{"defaultDirection":"desc","descKey":"audienceRating:desc","key":"audienceRating","title":"Audience Rating"},{"defaultDirection":"desc","descKey":"duration:desc","key":"duration","title":"Duration"},{"defaultDirection":"desc","descKey":"addedAt:desc","key":"addedAt","title":"Date Added"},{"defaultDirection":"desc","descKey":"lastViewedAt:desc","key":"lastViewedAt","title":"Date Viewed"},{"defaultDirection":"asc","descKey":"mediaHeight:desc","key":"mediaHeight","title":"Resolution"},{"defaultDirection":"desc","descKey":"random:desc","key":"random","title":"Randomly"}],"active":false,"key":"/library/sections/1/all?type=1","title":"Movies","type":"movie"}]` + + import('/content/types/models/operations/get_library_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `fieldType?`: *{`operations.FieldType[]`}* +
+**Example:** `[{"Operator":[{"key":"=","title":"is"}],"type":"resolution"}]` + + import('/content/types/models/operations/field_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_response/go.mdx b/content/types/models/operations/get_library_response/go.mdx index 3b4ae5c..33ada80 100644 --- a/content/types/models/operations/get_library_response/go.mdx +++ b/content/types/models/operations/get_library_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetLibraryResponseBody`}* +The details of the library + + import('/content/types/models/operations/get_library_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_response/python.mdx b/content/types/models/operations/get_library_response/python.mdx index 93ee0a0..834bf8b 100644 --- a/content/types/models/operations/get_library_response/python.mdx +++ b/content/types/models/operations/get_library_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetLibraryResponseBody]`}* +The details of the library + + import('/content/types/models/operations/get_library_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_response/typescript.mdx b/content/types/models/operations/get_library_response/typescript.mdx index 2035a36..776a794 100644 --- a/content/types/models/operations/get_library_response/typescript.mdx +++ b/content/types/models/operations/get_library_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetLibraryResponseBody`}* +The details of the library + + import('/content/types/models/operations/get_library_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_library_response_body/go.mdx b/content/types/models/operations/get_library_response_body/go.mdx new file mode 100644 index 0000000..9f1902d --- /dev/null +++ b/content/types/models/operations/get_library_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetLibraryMediaContainer`}* + + import('/content/types/models/operations/get_library_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_response_body/python.mdx b/content/types/models/operations/get_library_response_body/python.mdx new file mode 100644 index 0000000..beceae6 --- /dev/null +++ b/content/types/models/operations/get_library_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetLibraryMediaContainer]`}* + + import('/content/types/models/operations/get_library_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_response_body/typescript.mdx b/content/types/models/operations/get_library_response_body/typescript.mdx new file mode 100644 index 0000000..9f7db68 --- /dev/null +++ b/content/types/models/operations/get_library_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetLibraryMediaContainer`}* + + import('/content/types/models/operations/get_library_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_type/go.mdx b/content/types/models/operations/get_library_type/go.mdx new file mode 100644 index 0000000..2a6586e --- /dev/null +++ b/content/types/models/operations/get_library_type/go.mdx @@ -0,0 +1,48 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Key` *{`*string`}* +
+**Example:** `/library/sections/1/all?type=1` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `Active` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Filter` *{`[]operations.Filter`}* +
+**Example:** `[{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}]` + + import('/content/types/models/operations/filter/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Sort` *{`[]operations.Sort`}* +
+**Example:** `[{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}]` + + import('/content/types/models/operations/sort/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Field` *{`[]operations.Field`}* +
+**Example:** `[{"key":"label","subType":"bitrate","title":"Label","type":"tag"}]` + + import('/content/types/models/operations/field/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_type/python.mdx b/content/types/models/operations/get_library_type/python.mdx new file mode 100644 index 0000000..ccdd48f --- /dev/null +++ b/content/types/models/operations/get_library_type/python.mdx @@ -0,0 +1,48 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1/all?type=1` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `active` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `filter_` *{`List[operations.Filter]`}* +
+**Example:** `[{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}]` + + import('/content/types/models/operations/filter/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `sort` *{`List[operations.Sort]`}* +
+**Example:** `[{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}]` + + import('/content/types/models/operations/sort/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `field` *{`List[operations.Field]`}* +
+**Example:** `[{"key":"label","subType":"bitrate","title":"Label","type":"tag"}]` + + import('/content/types/models/operations/field/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_library_type/typescript.mdx b/content/types/models/operations/get_library_type/typescript.mdx new file mode 100644 index 0000000..c08cacd --- /dev/null +++ b/content/types/models/operations/get_library_type/typescript.mdx @@ -0,0 +1,48 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `key?`: *{`string`}* +
+**Example:** `/library/sections/1/all?type=1` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `active?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `filter?`: *{`operations.Filter[]`}* +
+**Example:** `[{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}]` + + import('/content/types/models/operations/filter/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `sort?`: *{`operations.Sort[]`}* +
+**Example:** `[{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}]` + + import('/content/types/models/operations/sort/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `field?`: *{`operations.Field[]`}* +
+**Example:** `[{"key":"label","subType":"bitrate","title":"Label","type":"tag"}]` + + import('/content/types/models/operations/field/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_directory/go.mdx b/content/types/models/operations/get_metadata_children_directory/go.mdx new file mode 100644 index 0000000..aa0a981 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_directory/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `LeafCount` *{`*int`}* +
+**Example:** `16` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `ViewedLeafCount` *{`*int`}* +
+**Example:** `16` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/30072/allLeaves` + +--- +##### `Title` *{`*string`}* +
+**Example:** `All episodes` + + diff --git a/content/types/models/operations/get_metadata_children_directory/python.mdx b/content/types/models/operations/get_metadata_children_directory/python.mdx new file mode 100644 index 0000000..5d7f3b2 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_directory/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `16` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `viewed_leaf_count` *{`Optional[int]`}* +
+**Example:** `16` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/allLeaves` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `All episodes` + + diff --git a/content/types/models/operations/get_metadata_children_directory/typescript.mdx b/content/types/models/operations/get_metadata_children_directory/typescript.mdx new file mode 100644 index 0000000..5eedb1e --- /dev/null +++ b/content/types/models/operations/get_metadata_children_directory/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `leafCount?`: *{`number`}* +
+**Example:** `16` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `viewedLeafCount?`: *{`number`}* +
+**Example:** `16` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/30072/allLeaves` + +--- +##### `title?`: *{`string`}* +
+**Example:** `All episodes` + + diff --git a/content/types/models/operations/get_metadata_children_media_container/go.mdx b/content/types/models/operations/get_metadata_children_media_container/go.mdx new file mode 100644 index 0000000..e0db641 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_media_container/go.mdx @@ -0,0 +1,125 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `3` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `Key` *{`*string`}* +
+**Example:** `30072` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `2` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `TV Shows` + +--- +##### `LibrarySectionUUID` *{`*string`}* +
+**Example:** `4bb2521c-8ba9-459b-aaee-8ab8bc35eabd` + +--- +##### `MediaTagPrefix` *{`*string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `MediaTagVersion` *{`*int`}* +
+**Example:** `1701731894` + +--- +##### `Nocache` *{`*bool`}* +
+**Example:** `true` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentTitle` *{`*string`}* +
+**Example:** `Reacher` + +--- +##### `ParentYear` *{`*int`}* +
+**Example:** `2022` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.` + +--- +##### `Theme` *{`*string`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `Title1` *{`*string`}* +
+**Example:** `TV Shows` + +--- +##### `Title2` *{`*string`}* +
+**Example:** `Reacher` + +--- +##### `ViewGroup` *{`*string`}* +
+**Example:** `season` + +--- +##### `ViewMode` *{`*int`}* +
+**Example:** `65593` + +--- +##### `Directory` *{`[]operations.GetMetadataChildrenDirectory`}* +
+**Example:** `[{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}]` + + import('/content/types/models/operations/get_metadata_children_directory/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Metadata` *{`[]operations.GetMetadataChildrenMetadata`}* +
+**Example:** `[{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}]` + + import('/content/types/models/operations/get_metadata_children_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_media_container/python.mdx b/content/types/models/operations/get_metadata_children_media_container/python.mdx new file mode 100644 index 0000000..2dd9dcc --- /dev/null +++ b/content/types/models/operations/get_metadata_children_media_container/python.mdx @@ -0,0 +1,125 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `3` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `30072` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `TV Shows` + +--- +##### `library_section_uuid` *{`Optional[str]`}* +
+**Example:** `4bb2521c-8ba9-459b-aaee-8ab8bc35eabd` + +--- +##### `media_tag_prefix` *{`Optional[str]`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `media_tag_version` *{`Optional[int]`}* +
+**Example:** `1701731894` + +--- +##### `nocache` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_title` *{`Optional[str]`}* +
+**Example:** `Reacher` + +--- +##### `parent_year` *{`Optional[int]`}* +
+**Example:** `2022` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.` + +--- +##### `theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `title1` *{`Optional[str]`}* +
+**Example:** `TV Shows` + +--- +##### `title2` *{`Optional[str]`}* +
+**Example:** `Reacher` + +--- +##### `view_group` *{`Optional[str]`}* +
+**Example:** `season` + +--- +##### `view_mode` *{`Optional[int]`}* +
+**Example:** `65593` + +--- +##### `directory` *{`List[operations.GetMetadataChildrenDirectory]`}* +
+**Example:** `[{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}]` + + import('/content/types/models/operations/get_metadata_children_directory/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `metadata` *{`List[operations.GetMetadataChildrenMetadata]`}* +
+**Example:** `[{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}]` + + import('/content/types/models/operations/get_metadata_children_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_media_container/typescript.mdx b/content/types/models/operations/get_metadata_children_media_container/typescript.mdx new file mode 100644 index 0000000..b94c633 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_media_container/typescript.mdx @@ -0,0 +1,125 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `3` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `key?`: *{`string`}* +
+**Example:** `30072` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `2` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `TV Shows` + +--- +##### `librarySectionUUID?`: *{`string`}* +
+**Example:** `4bb2521c-8ba9-459b-aaee-8ab8bc35eabd` + +--- +##### `mediaTagPrefix?`: *{`string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion?`: *{`number`}* +
+**Example:** `1701731894` + +--- +##### `nocache?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentTitle?`: *{`string`}* +
+**Example:** `Reacher` + +--- +##### `parentYear?`: *{`number`}* +
+**Example:** `2022` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.` + +--- +##### `theme?`: *{`string`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `title1?`: *{`string`}* +
+**Example:** `TV Shows` + +--- +##### `title2?`: *{`string`}* +
+**Example:** `Reacher` + +--- +##### `viewGroup?`: *{`string`}* +
+**Example:** `season` + +--- +##### `viewMode?`: *{`number`}* +
+**Example:** `65593` + +--- +##### `directory?`: *{`operations.GetMetadataChildrenDirectory[]`}* +
+**Example:** `[{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}]` + + import('/content/types/models/operations/get_metadata_children_directory/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `metadata?`: *{`operations.GetMetadataChildrenMetadata[]`}* +
+**Example:** `[{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}]` + + import('/content/types/models/operations/get_metadata_children_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_metadata/go.mdx b/content/types/models/operations/get_metadata_children_metadata/go.mdx new file mode 100644 index 0000000..ca09f2c --- /dev/null +++ b/content/types/models/operations/get_metadata_children_metadata/go.mdx @@ -0,0 +1,136 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `66488` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/66488/children` + +--- +##### `ParentRatingKey` *{`*string`}* +
+**Example:** `30072` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://season/652aea6549508477c34c6000` + +--- +##### `ParentGUID` *{`*string`}* +
+**Example:** `plex://show/5d9c09190aaccd001f8f42f0` + +--- +##### `ParentStudio` *{`*string`}* +
+**Example:** `Amazon Studios` + +--- +##### `Type` *{`*string`}* +
+**Example:** `season` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Season 2` + +--- +##### `ParentKey` *{`*string`}* +
+**Example:** `/library/metadata/30072` + +--- +##### `ParentTitle` *{`*string`}* +
+**Example:** `Reacher` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.` + +--- +##### `Index` *{`*int`}* +
+**Example:** `2` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `1` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `11` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1705646565` + +--- +##### `ParentYear` *{`*int`}* +
+**Example:** `2022` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/66488/thumb/1703065033` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `ParentThumb` *{`*string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `ParentTheme` *{`*string`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `8` + +--- +##### `ViewedLeafCount` *{`*int`}* +
+**Example:** `8` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1702602021` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1703065033` + +--- +##### `UserRating` *{`*int`}* +
+**Example:** `9` + +--- +##### `SkipCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `LastRatedAt` *{`*int`}* +
+**Example:** `1703881224` + + diff --git a/content/types/models/operations/get_metadata_children_metadata/python.mdx b/content/types/models/operations/get_metadata_children_metadata/python.mdx new file mode 100644 index 0000000..8d9d6ed --- /dev/null +++ b/content/types/models/operations/get_metadata_children_metadata/python.mdx @@ -0,0 +1,136 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `66488` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66488/children` + +--- +##### `parent_rating_key` *{`Optional[str]`}* +
+**Example:** `30072` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://season/652aea6549508477c34c6000` + +--- +##### `parent_guid` *{`Optional[str]`}* +
+**Example:** `plex://show/5d9c09190aaccd001f8f42f0` + +--- +##### `parent_studio` *{`Optional[str]`}* +
+**Example:** `Amazon Studios` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `season` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Season 2` + +--- +##### `parent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072` + +--- +##### `parent_title` *{`Optional[str]`}* +
+**Example:** `Reacher` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.` + +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `11` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1705646565` + +--- +##### `parent_year` *{`Optional[int]`}* +
+**Example:** `2022` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66488/thumb/1703065033` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `parent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `parent_theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `8` + +--- +##### `viewed_leaf_count` *{`Optional[int]`}* +
+**Example:** `8` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1702602021` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1703065033` + +--- +##### `user_rating` *{`Optional[int]`}* +
+**Example:** `9` + +--- +##### `skip_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `last_rated_at` *{`Optional[int]`}* +
+**Example:** `1703881224` + + diff --git a/content/types/models/operations/get_metadata_children_metadata/typescript.mdx b/content/types/models/operations/get_metadata_children_metadata/typescript.mdx new file mode 100644 index 0000000..ce6bee0 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_metadata/typescript.mdx @@ -0,0 +1,136 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `66488` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/66488/children` + +--- +##### `parentRatingKey?`: *{`string`}* +
+**Example:** `30072` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://season/652aea6549508477c34c6000` + +--- +##### `parentGuid?`: *{`string`}* +
+**Example:** `plex://show/5d9c09190aaccd001f8f42f0` + +--- +##### `parentStudio?`: *{`string`}* +
+**Example:** `Amazon Studios` + +--- +##### `type?`: *{`string`}* +
+**Example:** `season` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Season 2` + +--- +##### `parentKey?`: *{`string`}* +
+**Example:** `/library/metadata/30072` + +--- +##### `parentTitle?`: *{`string`}* +
+**Example:** `Reacher` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.` + +--- +##### `index?`: *{`number`}* +
+**Example:** `2` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `1` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `11` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1705646565` + +--- +##### `parentYear?`: *{`number`}* +
+**Example:** `2022` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/66488/thumb/1703065033` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `parentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `parentTheme?`: *{`string`}* +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `8` + +--- +##### `viewedLeafCount?`: *{`number`}* +
+**Example:** `8` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1702602021` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1703065033` + +--- +##### `userRating?`: *{`number`}* +
+**Example:** `9` + +--- +##### `skipCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `lastRatedAt?`: *{`number`}* +
+**Example:** `1703881224` + + diff --git a/content/types/models/operations/get_metadata_children_response/go.mdx b/content/types/models/operations/get_metadata_children_response/go.mdx index 3b4ae5c..2e71ab6 100644 --- a/content/types/models/operations/get_metadata_children_response/go.mdx +++ b/content/types/models/operations/get_metadata_children_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetMetadataChildrenResponseBody`}* +The children of the library item. + + import('/content/types/models/operations/get_metadata_children_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_children_response/python.mdx b/content/types/models/operations/get_metadata_children_response/python.mdx index 93ee0a0..fb4b3b4 100644 --- a/content/types/models/operations/get_metadata_children_response/python.mdx +++ b/content/types/models/operations/get_metadata_children_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetMetadataChildrenResponseBody]`}* +The children of the library item. + + import('/content/types/models/operations/get_metadata_children_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_children_response/typescript.mdx b/content/types/models/operations/get_metadata_children_response/typescript.mdx index 2035a36..e177c2c 100644 --- a/content/types/models/operations/get_metadata_children_response/typescript.mdx +++ b/content/types/models/operations/get_metadata_children_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetMetadataChildrenResponseBody`}* +The children of the library item. + + import('/content/types/models/operations/get_metadata_children_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_children_response_body/go.mdx b/content/types/models/operations/get_metadata_children_response_body/go.mdx new file mode 100644 index 0000000..1b531b4 --- /dev/null +++ b/content/types/models/operations/get_metadata_children_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetMetadataChildrenMediaContainer`}* + + import('/content/types/models/operations/get_metadata_children_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_response_body/python.mdx b/content/types/models/operations/get_metadata_children_response_body/python.mdx new file mode 100644 index 0000000..0a9c01c --- /dev/null +++ b/content/types/models/operations/get_metadata_children_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetMetadataChildrenMediaContainer]`}* + + import('/content/types/models/operations/get_metadata_children_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_children_response_body/typescript.mdx b/content/types/models/operations/get_metadata_children_response_body/typescript.mdx new file mode 100644 index 0000000..75abbde --- /dev/null +++ b/content/types/models/operations/get_metadata_children_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetMetadataChildrenMediaContainer`}* + + import('/content/types/models/operations/get_metadata_children_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_country/go.mdx b/content/types/models/operations/get_metadata_country/go.mdx new file mode 100644 index 0000000..4e91027 --- /dev/null +++ b/content/types/models/operations/get_metadata_country/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `116` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `country=116` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_metadata_country/python.mdx b/content/types/models/operations/get_metadata_country/python.mdx new file mode 100644 index 0000000..c7c005c --- /dev/null +++ b/content/types/models/operations/get_metadata_country/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `116` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `country=116` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_metadata_country/typescript.mdx b/content/types/models/operations/get_metadata_country/typescript.mdx new file mode 100644 index 0000000..0fb7aef --- /dev/null +++ b/content/types/models/operations/get_metadata_country/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `116` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `country=116` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_metadata_director/go.mdx b/content/types/models/operations/get_metadata_director/go.mdx new file mode 100644 index 0000000..7134216 --- /dev/null +++ b/content/types/models/operations/get_metadata_director/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `130` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `director=130` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `Joss Whedon` + +--- +##### `TagKey` *{`*string`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_metadata_director/python.mdx b/content/types/models/operations/get_metadata_director/python.mdx new file mode 100644 index 0000000..53fb967 --- /dev/null +++ b/content/types/models/operations/get_metadata_director/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `130` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `director=130` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `Joss Whedon` + +--- +##### `tag_key` *{`Optional[str]`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_metadata_director/typescript.mdx b/content/types/models/operations/get_metadata_director/typescript.mdx new file mode 100644 index 0000000..22d6904 --- /dev/null +++ b/content/types/models/operations/get_metadata_director/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `130` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `director=130` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `Joss Whedon` + +--- +##### `tagKey?`: *{`string`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_metadata_genre/go.mdx b/content/types/models/operations/get_metadata_genre/go.mdx new file mode 100644 index 0000000..4b49719 --- /dev/null +++ b/content/types/models/operations/get_metadata_genre/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `184` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `genre=184` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `Thriller` + + diff --git a/content/types/models/operations/get_metadata_genre/python.mdx b/content/types/models/operations/get_metadata_genre/python.mdx new file mode 100644 index 0000000..8b67cd5 --- /dev/null +++ b/content/types/models/operations/get_metadata_genre/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `184` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `genre=184` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `Thriller` + + diff --git a/content/types/models/operations/get_metadata_genre/typescript.mdx b/content/types/models/operations/get_metadata_genre/typescript.mdx new file mode 100644 index 0000000..2f85b92 --- /dev/null +++ b/content/types/models/operations/get_metadata_genre/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `184` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `genre=184` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `Thriller` + + diff --git a/content/types/models/operations/get_metadata_media/go.mdx b/content/types/models/operations/get_metadata_media/go.mdx new file mode 100644 index 0000000..6cf44e9 --- /dev/null +++ b/content/types/models/operations/get_metadata_media/go.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ID` *{`*int`}* +
+**Example:** `15` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141417` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `2278` + +--- +##### `Width` *{`*int`}* +
+**Example:** `1920` + +--- +##### `Height` *{`*int`}* +
+**Example:** `814` + +--- +##### `AspectRatio` *{`*float64`}* +
+**Example:** `2.35` + +--- +##### `AudioChannels` *{`*int`}* +
+**Example:** `2` + +--- +##### `AudioCodec` *{`*string`}* +
+**Example:** `aac` + +--- +##### `VideoCodec` *{`*string`}* +
+**Example:** `h264` + +--- +##### `VideoResolution` *{`*string`}* +
+**Example:** `1080` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `VideoFrameRate` *{`*string`}* +
+**Example:** `24p` + +--- +##### `OptimizedForStreaming` *{`*int`}* +
+**Example:** `0` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + +--- +##### `Part` *{`[]operations.GetMetadataPart`}* +
+**Example:** `[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_metadata_part/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_media/python.mdx b/content/types/models/operations/get_metadata_media/python.mdx new file mode 100644 index 0000000..859b4e5 --- /dev/null +++ b/content/types/models/operations/get_metadata_media/python.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id` *{`Optional[int]`}* +
+**Example:** `15` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141417` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `2278` + +--- +##### `width` *{`Optional[int]`}* +
+**Example:** `1920` + +--- +##### `height` *{`Optional[int]`}* +
+**Example:** `814` + +--- +##### `aspect_ratio` *{`Optional[float]`}* +
+**Example:** `2.35` + +--- +##### `audio_channels` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `audio_codec` *{`Optional[str]`}* +
+**Example:** `aac` + +--- +##### `video_codec` *{`Optional[str]`}* +
+**Example:** `h264` + +--- +##### `video_resolution` *{`Optional[str]`}* +
+**Example:** `1080` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `video_frame_rate` *{`Optional[str]`}* +
+**Example:** `24p` + +--- +##### `optimized_for_streaming` *{`Optional[int]`}* +
+**Example:** `0` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + +--- +##### `part` *{`List[operations.GetMetadataPart]`}* +
+**Example:** `[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_metadata_part/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_media/typescript.mdx b/content/types/models/operations/get_metadata_media/typescript.mdx new file mode 100644 index 0000000..4bd27ac --- /dev/null +++ b/content/types/models/operations/get_metadata_media/typescript.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id?`: *{`number`}* +
+**Example:** `15` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141417` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `2278` + +--- +##### `width?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `height?`: *{`number`}* +
+**Example:** `814` + +--- +##### `aspectRatio?`: *{`number`}* +
+**Example:** `2.35` + +--- +##### `audioChannels?`: *{`number`}* +
+**Example:** `2` + +--- +##### `audioCodec?`: *{`string`}* +
+**Example:** `aac` + +--- +##### `videoCodec?`: *{`string`}* +
+**Example:** `h264` + +--- +##### `videoResolution?`: *{`string`}* +
+**Example:** `1080` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `videoFrameRate?`: *{`string`}* +
+**Example:** `24p` + +--- +##### `optimizedForStreaming?`: *{`number`}* +
+**Example:** `0` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + +--- +##### `part?`: *{`operations.GetMetadataPart[]`}* +
+**Example:** `[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_metadata_part/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_media_container/go.mdx b/content/types/models/operations/get_metadata_media_container/go.mdx new file mode 100644 index 0000000..5391174 --- /dev/null +++ b/content/types/models/operations/get_metadata_media_container/go.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `1` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionUUID` *{`*string`}* +
+**Example:** `cfc899d7-3000-46f6-8489-b9592714ada5` + +--- +##### `MediaTagPrefix` *{`*string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `MediaTagVersion` *{`*int`}* +
+**Example:** `1698860922` + +--- +##### `Metadata` *{`[]operations.GetMetadataMetadata`}* +
+**Example:** `[{"Country":[{"filter":"country=116","id":116,"tag":"United States of America"}],"Director":[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"Genre":[{"filter":"genre=5","id":5,"tag":"Science Fiction"}],"Guid":[{"id":"imdb://tt0379786"}],"Media":[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Producer":[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}],"Rating":[{"image":"imdb://image.rating","type":"audience","value":7.8}],"Role":[{"filter":"actor=8","id":8,"role":"Malcolm \"Mal\" Reynolds","tag":"Nathan Fillion","tagKey":"5d7768286f4521001ea9945c","thumb":"https://metadata-static.plex.tv/4/people/4a2890ca346eb832500b1ed0add89d5e.jpg"}],"Writer":[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141417,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_metadata_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_media_container/python.mdx b/content/types/models/operations/get_metadata_media_container/python.mdx new file mode 100644 index 0000000..c09425a --- /dev/null +++ b/content/types/models/operations/get_metadata_media_container/python.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_uuid` *{`Optional[str]`}* +
+**Example:** `cfc899d7-3000-46f6-8489-b9592714ada5` + +--- +##### `media_tag_prefix` *{`Optional[str]`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `media_tag_version` *{`Optional[int]`}* +
+**Example:** `1698860922` + +--- +##### `metadata` *{`List[operations.GetMetadataMetadata]`}* +
+**Example:** `[{"Country":[{"filter":"country=116","id":116,"tag":"United States of America"}],"Director":[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"Genre":[{"filter":"genre=5","id":5,"tag":"Science Fiction"}],"Guid":[{"id":"imdb://tt0379786"}],"Media":[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Producer":[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}],"Rating":[{"image":"imdb://image.rating","type":"audience","value":7.8}],"Role":[{"filter":"actor=8","id":8,"role":"Malcolm \"Mal\" Reynolds","tag":"Nathan Fillion","tagKey":"5d7768286f4521001ea9945c","thumb":"https://metadata-static.plex.tv/4/people/4a2890ca346eb832500b1ed0add89d5e.jpg"}],"Writer":[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141417,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_metadata_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_media_container/typescript.mdx b/content/types/models/operations/get_metadata_media_container/typescript.mdx new file mode 100644 index 0000000..9a58275 --- /dev/null +++ b/content/types/models/operations/get_metadata_media_container/typescript.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `1` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionUUID?`: *{`string`}* +
+**Example:** `cfc899d7-3000-46f6-8489-b9592714ada5` + +--- +##### `mediaTagPrefix?`: *{`string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion?`: *{`number`}* +
+**Example:** `1698860922` + +--- +##### `metadata?`: *{`operations.GetMetadataMetadata[]`}* +
+**Example:** `[{"Country":[{"filter":"country=116","id":116,"tag":"United States of America"}],"Director":[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"Genre":[{"filter":"genre=5","id":5,"tag":"Science Fiction"}],"Guid":[{"id":"imdb://tt0379786"}],"Media":[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Producer":[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}],"Rating":[{"image":"imdb://image.rating","type":"audience","value":7.8}],"Role":[{"filter":"actor=8","id":8,"role":"Malcolm \"Mal\" Reynolds","tag":"Nathan Fillion","tagKey":"5d7768286f4521001ea9945c","thumb":"https://metadata-static.plex.tv/4/people/4a2890ca346eb832500b1ed0add89d5e.jpg"}],"Writer":[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141417,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_metadata_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_metadata/go.mdx b/content/types/models/operations/get_metadata_metadata/go.mdx new file mode 100644 index 0000000..bca1390 --- /dev/null +++ b/content/types/models/operations/get_metadata_metadata/go.mdx @@ -0,0 +1,196 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `RatingKey` *{`*string`}* +
+**Example:** `17` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/17` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `Studio` *{`*string`}* +
+**Example:** `Universal Pictures` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Serenity` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionKey` *{`*string`}* +
+**Example:** `/library/sections/1` + +--- +##### `ContentRating` *{`*string`}* +
+**Example:** `PG-13` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `Rating` *{`*float64`}* +
+**Example:** `8.2` + +--- +##### `AudienceRating` *{`*float64`}* +
+**Example:** `9.1` + +--- +##### `Year` *{`*int`}* +
+**Example:** `2005` + +--- +##### `Tagline` *{`*string`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141417` + +--- +##### `OriginallyAvailableAt` *{`*types.Date`}* +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705637164` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705637165` + +--- +##### `AudienceRatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `HasPremiumPrimaryExtra` *{`*string`}* +
+**Example:** `1` + +--- +##### `RatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `Media` *{`[]operations.GetMetadataMedia`}* +
+**Example:** `[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_metadata_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Genre` *{`[]operations.GetMetadataGenre`}* +
+**Example:** `[{"filter":"genre=184","id":184,"tag":"Thriller"}]` + + import('/content/types/models/operations/get_metadata_genre/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Country` *{`[]operations.GetMetadataCountry`}* +
+**Example:** `[{"filter":"country=116","id":116,"tag":"United States of America"}]` + + import('/content/types/models/operations/get_metadata_country/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Guids` *{`[]operations.Guids`}* +
+**Example:** `[{"id":"tvdb://2337"}]` + + import('/content/types/models/operations/guids/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Ratings` *{`[]operations.Ratings`}* +
+**Example:** `[{"image":"themoviedb://image.rating","type":"audience","value":7.4}]` + + import('/content/types/models/operations/ratings/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Director` *{`[]operations.GetMetadataDirector`}* +
+**Example:** `[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_director/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Writer` *{`[]operations.GetMetadataWriter`}* +
+**Example:** `[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_writer/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Role` *{`[]operations.GetMetadataRole`}* +
+**Example:** `[{"filter":"actor=220","id":220,"role":"Bar Guy (uncredited)","tag":"Dennis Keiffer","tagKey":"5d77683554f42c001f8c4708","thumb":"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"}]` + + import('/content/types/models/operations/get_metadata_role/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Producer` *{`[]operations.Producer`}* +
+**Example:** `[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}]` + + import('/content/types/models/operations/producer/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_metadata/python.mdx b/content/types/models/operations/get_metadata_metadata/python.mdx new file mode 100644 index 0000000..1f82dbd --- /dev/null +++ b/content/types/models/operations/get_metadata_metadata/python.mdx @@ -0,0 +1,196 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `17` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio` *{`Optional[str]`}* +
+**Example:** `Universal Pictures` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Serenity` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1` + +--- +##### `content_rating` *{`Optional[str]`}* +
+**Example:** `PG-13` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating` *{`Optional[float]`}* +
+**Example:** `8.2` + +--- +##### `audience_rating` *{`Optional[float]`}* +
+**Example:** `9.1` + +--- +##### `year` *{`Optional[int]`}* +
+**Example:** `2005` + +--- +##### `tagline` *{`Optional[str]`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141417` + +--- +##### `originally_available_at` [*{ `datetime` }*](https://docs.python.org/3/library/datetime.html#datetime-objects) +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705637164` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705637165` + +--- +##### `audience_rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `has_premium_primary_extra` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` *{`List[operations.GetMetadataMedia]`}* +
+**Example:** `[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_metadata_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre` *{`List[operations.GetMetadataGenre]`}* +
+**Example:** `[{"filter":"genre=184","id":184,"tag":"Thriller"}]` + + import('/content/types/models/operations/get_metadata_genre/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country` *{`List[operations.GetMetadataCountry]`}* +
+**Example:** `[{"filter":"country=116","id":116,"tag":"United States of America"}]` + + import('/content/types/models/operations/get_metadata_country/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `guids` *{`List[operations.Guids]`}* +
+**Example:** `[{"id":"tvdb://2337"}]` + + import('/content/types/models/operations/guids/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `ratings` *{`List[operations.Ratings]`}* +
+**Example:** `[{"image":"themoviedb://image.rating","type":"audience","value":7.4}]` + + import('/content/types/models/operations/ratings/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director` *{`List[operations.GetMetadataDirector]`}* +
+**Example:** `[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_director/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer` *{`List[operations.GetMetadataWriter]`}* +
+**Example:** `[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_writer/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role` *{`List[operations.GetMetadataRole]`}* +
+**Example:** `[{"filter":"actor=220","id":220,"role":"Bar Guy (uncredited)","tag":"Dennis Keiffer","tagKey":"5d77683554f42c001f8c4708","thumb":"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"}]` + + import('/content/types/models/operations/get_metadata_role/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `producer` *{`List[operations.Producer]`}* +
+**Example:** `[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}]` + + import('/content/types/models/operations/producer/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_metadata/typescript.mdx b/content/types/models/operations/get_metadata_metadata/typescript.mdx new file mode 100644 index 0000000..ef43cfa --- /dev/null +++ b/content/types/models/operations/get_metadata_metadata/typescript.mdx @@ -0,0 +1,196 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ratingKey?`: *{`string`}* +
+**Example:** `17` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/17` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio?`: *{`string`}* +
+**Example:** `Universal Pictures` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Serenity` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionKey?`: *{`string`}* +
+**Example:** `/library/sections/1` + +--- +##### `contentRating?`: *{`string`}* +
+**Example:** `PG-13` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating?`: *{`number`}* +
+**Example:** `8.2` + +--- +##### `audienceRating?`: *{`number`}* +
+**Example:** `9.1` + +--- +##### `year?`: *{`number`}* +
+**Example:** `2005` + +--- +##### `tagline?`: *{`string`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141417` + +--- +##### `originallyAvailableAt?`: *{`RFCDate`}* +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705637164` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705637165` + +--- +##### `audienceRatingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `hasPremiumPrimaryExtra?`: *{`string`}* +
+**Example:** `1` + +--- +##### `ratingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media?`: *{`operations.GetMetadataMedia[]`}* +
+**Example:** `[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_metadata_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre?`: *{`operations.GetMetadataGenre[]`}* +
+**Example:** `[{"filter":"genre=184","id":184,"tag":"Thriller"}]` + + import('/content/types/models/operations/get_metadata_genre/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country?`: *{`operations.GetMetadataCountry[]`}* +
+**Example:** `[{"filter":"country=116","id":116,"tag":"United States of America"}]` + + import('/content/types/models/operations/get_metadata_country/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `guids?`: *{`operations.Guids[]`}* +
+**Example:** `[{"id":"tvdb://2337"}]` + + import('/content/types/models/operations/guids/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `ratings?`: *{`operations.Ratings[]`}* +
+**Example:** `[{"image":"themoviedb://image.rating","type":"audience","value":7.4}]` + + import('/content/types/models/operations/ratings/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director?`: *{`operations.GetMetadataDirector[]`}* +
+**Example:** `[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_director/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer?`: *{`operations.GetMetadataWriter[]`}* +
+**Example:** `[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + + import('/content/types/models/operations/get_metadata_writer/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role?`: *{`operations.GetMetadataRole[]`}* +
+**Example:** `[{"filter":"actor=220","id":220,"role":"Bar Guy (uncredited)","tag":"Dennis Keiffer","tagKey":"5d77683554f42c001f8c4708","thumb":"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"}]` + + import('/content/types/models/operations/get_metadata_role/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `producer?`: *{`operations.Producer[]`}* +
+**Example:** `[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}]` + + import('/content/types/models/operations/producer/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_part/go.mdx b/content/types/models/operations/get_metadata_part/go.mdx new file mode 100644 index 0000000..32836cc --- /dev/null +++ b/content/types/models/operations/get_metadata_part/go.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ID` *{`*int`}* +
+**Example:** `15` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141417` + +--- +##### `File` *{`*string`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `Size` *{`*int`}* +
+**Example:** `40271948` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `OptimizedForStreaming` *{`*bool`}* +
+**Example:** `false` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + +--- +##### `Stream` *{`[]operations.Stream`}* +
+**Example:** `[{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}]` + + import('/content/types/models/operations/stream/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_part/python.mdx b/content/types/models/operations/get_metadata_part/python.mdx new file mode 100644 index 0000000..2255079 --- /dev/null +++ b/content/types/models/operations/get_metadata_part/python.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id` *{`Optional[int]`}* +
+**Example:** `15` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141417` + +--- +##### `file` *{`Optional[str]`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `40271948` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `optimized_for_streaming` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + +--- +##### `stream` *{`List[operations.Stream]`}* +
+**Example:** `[{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}]` + + import('/content/types/models/operations/stream/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_part/typescript.mdx b/content/types/models/operations/get_metadata_part/typescript.mdx new file mode 100644 index 0000000..1508d62 --- /dev/null +++ b/content/types/models/operations/get_metadata_part/typescript.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id?`: *{`number`}* +
+**Example:** `15` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141417` + +--- +##### `file?`: *{`string`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size?`: *{`number`}* +
+**Example:** `40271948` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `optimizedForStreaming?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + +--- +##### `stream?`: *{`operations.Stream[]`}* +
+**Example:** `[{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}]` + + import('/content/types/models/operations/stream/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_response/go.mdx b/content/types/models/operations/get_metadata_response/go.mdx index 3b4ae5c..c68fd37 100644 --- a/content/types/models/operations/get_metadata_response/go.mdx +++ b/content/types/models/operations/get_metadata_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetMetadataResponseBody`}* +The metadata of the library item. + + import('/content/types/models/operations/get_metadata_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_response/python.mdx b/content/types/models/operations/get_metadata_response/python.mdx index 93ee0a0..6d618ab 100644 --- a/content/types/models/operations/get_metadata_response/python.mdx +++ b/content/types/models/operations/get_metadata_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetMetadataResponseBody]`}* +The metadata of the library item. + + import('/content/types/models/operations/get_metadata_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_response/typescript.mdx b/content/types/models/operations/get_metadata_response/typescript.mdx index 2035a36..83e7e05 100644 --- a/content/types/models/operations/get_metadata_response/typescript.mdx +++ b/content/types/models/operations/get_metadata_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetMetadataResponseBody`}* +The metadata of the library item. + + import('/content/types/models/operations/get_metadata_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_metadata_response_body/go.mdx b/content/types/models/operations/get_metadata_response_body/go.mdx new file mode 100644 index 0000000..00db5e5 --- /dev/null +++ b/content/types/models/operations/get_metadata_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetMetadataMediaContainer`}* + + import('/content/types/models/operations/get_metadata_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_response_body/python.mdx b/content/types/models/operations/get_metadata_response_body/python.mdx new file mode 100644 index 0000000..b004d79 --- /dev/null +++ b/content/types/models/operations/get_metadata_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetMetadataMediaContainer]`}* + + import('/content/types/models/operations/get_metadata_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_response_body/typescript.mdx b/content/types/models/operations/get_metadata_response_body/typescript.mdx new file mode 100644 index 0000000..d817a0e --- /dev/null +++ b/content/types/models/operations/get_metadata_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetMetadataMediaContainer`}* + + import('/content/types/models/operations/get_metadata_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_metadata_role/go.mdx b/content/types/models/operations/get_metadata_role/go.mdx new file mode 100644 index 0000000..7b46da1 --- /dev/null +++ b/content/types/models/operations/get_metadata_role/go.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `220` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `actor=220` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `Dennis Keiffer` + +--- +##### `TagKey` *{`*string`}* +
+**Example:** `5d77683554f42c001f8c4708` + +--- +##### `Role` *{`*string`}* +
+**Example:** `Bar Guy (uncredited)` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg` + + diff --git a/content/types/models/operations/get_metadata_role/python.mdx b/content/types/models/operations/get_metadata_role/python.mdx new file mode 100644 index 0000000..c79d301 --- /dev/null +++ b/content/types/models/operations/get_metadata_role/python.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `220` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `actor=220` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `Dennis Keiffer` + +--- +##### `tag_key` *{`Optional[str]`}* +
+**Example:** `5d77683554f42c001f8c4708` + +--- +##### `role` *{`Optional[str]`}* +
+**Example:** `Bar Guy (uncredited)` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg` + + diff --git a/content/types/models/operations/get_metadata_role/typescript.mdx b/content/types/models/operations/get_metadata_role/typescript.mdx new file mode 100644 index 0000000..ca39bf2 --- /dev/null +++ b/content/types/models/operations/get_metadata_role/typescript.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `220` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `actor=220` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `Dennis Keiffer` + +--- +##### `tagKey?`: *{`string`}* +
+**Example:** `5d77683554f42c001f8c4708` + +--- +##### `role?`: *{`string`}* +
+**Example:** `Bar Guy (uncredited)` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg` + + diff --git a/content/types/models/operations/get_metadata_writer/go.mdx b/content/types/models/operations/get_metadata_writer/go.mdx new file mode 100644 index 0000000..8151c1a --- /dev/null +++ b/content/types/models/operations/get_metadata_writer/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `132` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `writer=132` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `Joss Whedon` + +--- +##### `TagKey` *{`*string`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_metadata_writer/python.mdx b/content/types/models/operations/get_metadata_writer/python.mdx new file mode 100644 index 0000000..f5e3503 --- /dev/null +++ b/content/types/models/operations/get_metadata_writer/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `132` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `writer=132` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `Joss Whedon` + +--- +##### `tag_key` *{`Optional[str]`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_metadata_writer/typescript.mdx b/content/types/models/operations/get_metadata_writer/typescript.mdx new file mode 100644 index 0000000..7ce7fd6 --- /dev/null +++ b/content/types/models/operations/get_metadata_writer/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `132` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `writer=132` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `Joss Whedon` + +--- +##### `tagKey?`: *{`string`}* +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/models/operations/get_on_deck_guids/go.mdx b/content/types/models/operations/get_on_deck_guids/go.mdx new file mode 100644 index 0000000..50de91e --- /dev/null +++ b/content/types/models/operations/get_on_deck_guids/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*string`}* +
+**Example:** `imdb://tt13303712` + + diff --git a/content/types/models/operations/get_on_deck_guids/python.mdx b/content/types/models/operations/get_on_deck_guids/python.mdx new file mode 100644 index 0000000..731e74c --- /dev/null +++ b/content/types/models/operations/get_on_deck_guids/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[str]`}* +
+**Example:** `imdb://tt13303712` + + diff --git a/content/types/models/operations/get_on_deck_guids/typescript.mdx b/content/types/models/operations/get_on_deck_guids/typescript.mdx new file mode 100644 index 0000000..858506b --- /dev/null +++ b/content/types/models/operations/get_on_deck_guids/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`string`}* +
+**Example:** `imdb://tt13303712` + + diff --git a/content/types/models/operations/get_on_deck_metadata/go.mdx b/content/types/models/operations/get_on_deck_metadata/go.mdx index 7a75905..3ca9ad2 100644 --- a/content/types/models/operations/get_on_deck_metadata/go.mdx +++ b/content/types/models/operations/get_on_deck_metadata/go.mdx @@ -176,9 +176,9 @@ import Labels from "/src/lib/labels"; --- -##### `Guids` *{`[]operations.Guids`}* +##### `Guids` *{`[]operations.GetOnDeckGuids`}* - import('/content/types/models/operations/guids/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_guids/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_metadata/python.mdx b/content/types/models/operations/get_on_deck_metadata/python.mdx index caa69d8..5b446d5 100644 --- a/content/types/models/operations/get_on_deck_metadata/python.mdx +++ b/content/types/models/operations/get_on_deck_metadata/python.mdx @@ -176,9 +176,9 @@ import Labels from "/src/lib/labels"; --- -##### `guids` *{`List[operations.Guids]`}* +##### `guids` *{`List[operations.GetOnDeckGuids]`}* - import('/content/types/models/operations/guids/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_guids/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_metadata/typescript.mdx b/content/types/models/operations/get_on_deck_metadata/typescript.mdx index 2f7bdb2..28fc776 100644 --- a/content/types/models/operations/get_on_deck_metadata/typescript.mdx +++ b/content/types/models/operations/get_on_deck_metadata/typescript.mdx @@ -176,9 +176,9 @@ import Labels from "/src/lib/labels"; --- -##### `guids?`: *{`operations.Guids[]`}* +##### `guids?`: *{`operations.GetOnDeckGuids[]`}* - import('/content/types/models/operations/guids/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_guids/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_part/go.mdx b/content/types/models/operations/get_on_deck_part/go.mdx index f54e7c4..ec78593 100644 --- a/content/types/models/operations/get_on_deck_part/go.mdx +++ b/content/types/models/operations/get_on_deck_part/go.mdx @@ -42,9 +42,9 @@ import Labels from "/src/lib/labels"; **Example:** `main` --- -##### `Stream` *{`[]operations.Stream`}* +##### `Stream` *{`[]operations.GetOnDeckStream`}* - import('/content/types/models/operations/stream/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_stream/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_part/python.mdx b/content/types/models/operations/get_on_deck_part/python.mdx index e331bcc..844ab49 100644 --- a/content/types/models/operations/get_on_deck_part/python.mdx +++ b/content/types/models/operations/get_on_deck_part/python.mdx @@ -42,9 +42,9 @@ import Labels from "/src/lib/labels"; **Example:** `main` --- -##### `stream` *{`List[operations.Stream]`}* +##### `stream` *{`List[operations.GetOnDeckStream]`}* - import('/content/types/models/operations/stream/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_stream/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_part/typescript.mdx b/content/types/models/operations/get_on_deck_part/typescript.mdx index dd57cfa..acf9bbf 100644 --- a/content/types/models/operations/get_on_deck_part/typescript.mdx +++ b/content/types/models/operations/get_on_deck_part/typescript.mdx @@ -42,9 +42,9 @@ import Labels from "/src/lib/labels"; **Example:** `main` --- -##### `stream?`: *{`operations.Stream[]`}* +##### `stream?`: *{`operations.GetOnDeckStream[]`}* - import('/content/types/models/operations/stream/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_on_deck_stream/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_on_deck_stream/go.mdx b/content/types/models/operations/get_on_deck_stream/go.mdx new file mode 100644 index 0000000..6ad0a2a --- /dev/null +++ b/content/types/models/operations/get_on_deck_stream/go.mdx @@ -0,0 +1,114 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*float64`}* +
+**Example:** `211234` + +--- +##### `StreamType` *{`*float64`}* +
+**Example:** `1` + +--- +##### `Default` *{`*bool`}* + +--- +##### `Codec` *{`*string`}* +
+**Example:** `hevc` + +--- +##### `Index` *{`*float64`}* +
+**Example:** `0` + +--- +##### `Bitrate` *{`*float64`}* +
+**Example:** `918` + +--- +##### `Language` *{`*string`}* +
+**Example:** `English` + +--- +##### `LanguageTag` *{`*string`}* +
+**Example:** `en` + +--- +##### `LanguageCode` *{`*string`}* +
+**Example:** `eng` + +--- +##### `BitDepth` *{`*float64`}* +
+**Example:** `8` + +--- +##### `ChromaLocation` *{`*string`}* +
+**Example:** `left` + +--- +##### `ChromaSubsampling` *{`*string`}* +
+**Example:** `4:2:0` + +--- +##### `CodedHeight` *{`*float64`}* +
+**Example:** `1080` + +--- +##### `CodedWidth` *{`*float64`}* +
+**Example:** `1920` + +--- +##### `ColorRange` *{`*string`}* +
+**Example:** `tv` + +--- +##### `FrameRate` *{`*float64`}* +
+**Example:** `25` + +--- +##### `Height` *{`*float64`}* +
+**Example:** `1080` + +--- +##### `Level` *{`*float64`}* +
+**Example:** `120` + +--- +##### `Profile` *{`*string`}* +
+**Example:** `main` + +--- +##### `RefFrames` *{`*float64`}* +
+**Example:** `1` + +--- +##### `Width` *{`*float64`}* +
+**Example:** `1920` + +--- +##### `DisplayTitle` *{`*string`}* +
+**Example:** `1080p (HEVC Main)` + +--- +##### `ExtendedDisplayTitle` *{`*string`}* +
+**Example:** `1080p (HEVC Main)` + + diff --git a/content/types/models/operations/get_on_deck_stream/python.mdx b/content/types/models/operations/get_on_deck_stream/python.mdx new file mode 100644 index 0000000..595d01d --- /dev/null +++ b/content/types/models/operations/get_on_deck_stream/python.mdx @@ -0,0 +1,114 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[float]`}* +
+**Example:** `211234` + +--- +##### `stream_type` *{`Optional[float]`}* +
+**Example:** `1` + +--- +##### `default` *{`Optional[bool]`}* + +--- +##### `codec` *{`Optional[str]`}* +
+**Example:** `hevc` + +--- +##### `index` *{`Optional[float]`}* +
+**Example:** `0` + +--- +##### `bitrate` *{`Optional[float]`}* +
+**Example:** `918` + +--- +##### `language` *{`Optional[str]`}* +
+**Example:** `English` + +--- +##### `language_tag` *{`Optional[str]`}* +
+**Example:** `en` + +--- +##### `language_code` *{`Optional[str]`}* +
+**Example:** `eng` + +--- +##### `bit_depth` *{`Optional[float]`}* +
+**Example:** `8` + +--- +##### `chroma_location` *{`Optional[str]`}* +
+**Example:** `left` + +--- +##### `chroma_subsampling` *{`Optional[str]`}* +
+**Example:** `4:2:0` + +--- +##### `coded_height` *{`Optional[float]`}* +
+**Example:** `1080` + +--- +##### `coded_width` *{`Optional[float]`}* +
+**Example:** `1920` + +--- +##### `color_range` *{`Optional[str]`}* +
+**Example:** `tv` + +--- +##### `frame_rate` *{`Optional[float]`}* +
+**Example:** `25` + +--- +##### `height` *{`Optional[float]`}* +
+**Example:** `1080` + +--- +##### `level` *{`Optional[float]`}* +
+**Example:** `120` + +--- +##### `profile` *{`Optional[str]`}* +
+**Example:** `main` + +--- +##### `ref_frames` *{`Optional[float]`}* +
+**Example:** `1` + +--- +##### `width` *{`Optional[float]`}* +
+**Example:** `1920` + +--- +##### `display_title` *{`Optional[str]`}* +
+**Example:** `1080p (HEVC Main)` + +--- +##### `extended_display_title` *{`Optional[str]`}* +
+**Example:** `1080p (HEVC Main)` + + diff --git a/content/types/models/operations/get_on_deck_stream/typescript.mdx b/content/types/models/operations/get_on_deck_stream/typescript.mdx new file mode 100644 index 0000000..d079c58 --- /dev/null +++ b/content/types/models/operations/get_on_deck_stream/typescript.mdx @@ -0,0 +1,114 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `211234` + +--- +##### `streamType?`: *{`number`}* +
+**Example:** `1` + +--- +##### `default?`: *{`boolean`}* + +--- +##### `codec?`: *{`string`}* +
+**Example:** `hevc` + +--- +##### `index?`: *{`number`}* +
+**Example:** `0` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `918` + +--- +##### `language?`: *{`string`}* +
+**Example:** `English` + +--- +##### `languageTag?`: *{`string`}* +
+**Example:** `en` + +--- +##### `languageCode?`: *{`string`}* +
+**Example:** `eng` + +--- +##### `bitDepth?`: *{`number`}* +
+**Example:** `8` + +--- +##### `chromaLocation?`: *{`string`}* +
+**Example:** `left` + +--- +##### `chromaSubsampling?`: *{`string`}* +
+**Example:** `4:2:0` + +--- +##### `codedHeight?`: *{`number`}* +
+**Example:** `1080` + +--- +##### `codedWidth?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `colorRange?`: *{`string`}* +
+**Example:** `tv` + +--- +##### `frameRate?`: *{`number`}* +
+**Example:** `25` + +--- +##### `height?`: *{`number`}* +
+**Example:** `1080` + +--- +##### `level?`: *{`number`}* +
+**Example:** `120` + +--- +##### `profile?`: *{`string`}* +
+**Example:** `main` + +--- +##### `refFrames?`: *{`number`}* +
+**Example:** `1` + +--- +##### `width?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `displayTitle?`: *{`string`}* +
+**Example:** `1080p (HEVC Main)` + +--- +##### `extendedDisplayTitle?`: *{`string`}* +
+**Example:** `1080p (HEVC Main)` + + diff --git a/content/types/models/operations/get_playlist_contents_country/go.mdx b/content/types/models/operations/get_playlist_contents_country/go.mdx new file mode 100644 index 0000000..325b7e8 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_country/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_playlist_contents_country/python.mdx b/content/types/models/operations/get_playlist_contents_country/python.mdx new file mode 100644 index 0000000..437d086 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_country/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_playlist_contents_country/typescript.mdx b/content/types/models/operations/get_playlist_contents_country/typescript.mdx new file mode 100644 index 0000000..53ee7ea --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_country/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `United States of America` + + diff --git a/content/types/models/operations/get_playlist_contents_director/go.mdx b/content/types/models/operations/get_playlist_contents_director/go.mdx new file mode 100644 index 0000000..cbcae12 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_director/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_contents_director/python.mdx b/content/types/models/operations/get_playlist_contents_director/python.mdx new file mode 100644 index 0000000..076a7a4 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_director/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_contents_director/typescript.mdx b/content/types/models/operations/get_playlist_contents_director/typescript.mdx new file mode 100644 index 0000000..e4f5625 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_director/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_contents_genre/go.mdx b/content/types/models/operations/get_playlist_contents_genre/go.mdx new file mode 100644 index 0000000..3c2fe01 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_genre/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Action` + + diff --git a/content/types/models/operations/get_playlist_contents_genre/python.mdx b/content/types/models/operations/get_playlist_contents_genre/python.mdx new file mode 100644 index 0000000..6bd3237 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_genre/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Action` + + diff --git a/content/types/models/operations/get_playlist_contents_genre/typescript.mdx b/content/types/models/operations/get_playlist_contents_genre/typescript.mdx new file mode 100644 index 0000000..28487d2 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_genre/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Action` + + diff --git a/content/types/models/operations/get_playlist_contents_media/go.mdx b/content/types/models/operations/get_playlist_contents_media/go.mdx new file mode 100644 index 0000000..5e3e89c --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media/go.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ID` *{`*int`}* +
+**Example:** `15` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141416` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `2273` + +--- +##### `Width` *{`*int`}* +
+**Example:** `1920` + +--- +##### `Height` *{`*int`}* +
+**Example:** `814` + +--- +##### `AspectRatio` *{`*float64`}* +
+**Example:** `2.35` + +--- +##### `AudioChannels` *{`*int`}* +
+**Example:** `2` + +--- +##### `AudioCodec` *{`*string`}* +
+**Example:** `aac` + +--- +##### `VideoCodec` *{`*string`}* +
+**Example:** `h264` + +--- +##### `VideoResolution` *{`*string`}* +
+**Example:** `1080` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `VideoFrameRate` *{`*string`}* +
+**Example:** `24p` + +--- +##### `OptimizedForStreaming` *{`*int`}* +
+**Example:** `0` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + +--- +##### `Part` *{`[]operations.GetPlaylistContentsPart`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_playlist_contents_part/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_media/python.mdx b/content/types/models/operations/get_playlist_contents_media/python.mdx new file mode 100644 index 0000000..486c515 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media/python.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id` *{`Optional[int]`}* +
+**Example:** `15` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141416` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `2273` + +--- +##### `width` *{`Optional[int]`}* +
+**Example:** `1920` + +--- +##### `height` *{`Optional[int]`}* +
+**Example:** `814` + +--- +##### `aspect_ratio` *{`Optional[float]`}* +
+**Example:** `2.35` + +--- +##### `audio_channels` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `audio_codec` *{`Optional[str]`}* +
+**Example:** `aac` + +--- +##### `video_codec` *{`Optional[str]`}* +
+**Example:** `h264` + +--- +##### `video_resolution` *{`Optional[str]`}* +
+**Example:** `1080` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `video_frame_rate` *{`Optional[str]`}* +
+**Example:** `24p` + +--- +##### `optimized_for_streaming` *{`Optional[int]`}* +
+**Example:** `0` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + +--- +##### `part` *{`List[operations.GetPlaylistContentsPart]`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_playlist_contents_part/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_media/typescript.mdx b/content/types/models/operations/get_playlist_contents_media/typescript.mdx new file mode 100644 index 0000000..df82289 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media/typescript.mdx @@ -0,0 +1,92 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `id?`: *{`number`}* +
+**Example:** `15` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141416` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `2273` + +--- +##### `width?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `height?`: *{`number`}* +
+**Example:** `814` + +--- +##### `aspectRatio?`: *{`number`}* +
+**Example:** `2.35` + +--- +##### `audioChannels?`: *{`number`}* +
+**Example:** `2` + +--- +##### `audioCodec?`: *{`string`}* +
+**Example:** `aac` + +--- +##### `videoCodec?`: *{`string`}* +
+**Example:** `h264` + +--- +##### `videoResolution?`: *{`string`}* +
+**Example:** `1080` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `videoFrameRate?`: *{`string`}* +
+**Example:** `24p` + +--- +##### `optimizedForStreaming?`: *{`number`}* +
+**Example:** `0` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + +--- +##### `part?`: *{`operations.GetPlaylistContentsPart[]`}* +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + import('/content/types/models/operations/get_playlist_contents_part/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_media_container/go.mdx b/content/types/models/operations/get_playlist_contents_media_container/go.mdx new file mode 100644 index 0000000..8283756 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media_container/go.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `2` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/95/composite/1705717521` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `282` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `2` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `RatingKey` *{`*string`}* +
+**Example:** `95` + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `Metadata` *{`[]operations.GetPlaylistContentsMetadata`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Joss Whedon"}],"Genre":[{"tag":"Science Fiction"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Nathan Fillion"}],"Writer":[{"tag":"Joss Whedon"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141416,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","titleSort":"Amazing Spider-Man 2","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_playlist_contents_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_media_container/python.mdx b/content/types/models/operations/get_playlist_contents_media_container/python.mdx new file mode 100644 index 0000000..be63beb --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media_container/python.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/95/composite/1705717521` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `282` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `95` + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `metadata` *{`List[operations.GetPlaylistContentsMetadata]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Joss Whedon"}],"Genre":[{"tag":"Science Fiction"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Nathan Fillion"}],"Writer":[{"tag":"Joss Whedon"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141416,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","titleSort":"Amazing Spider-Man 2","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_playlist_contents_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_media_container/typescript.mdx b/content/types/models/operations/get_playlist_contents_media_container/typescript.mdx new file mode 100644 index 0000000..2c5a92e --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_media_container/typescript.mdx @@ -0,0 +1,52 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `2` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/95/composite/1705717521` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `282` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `2` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `ratingKey?`: *{`string`}* +
+**Example:** `95` + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `metadata?`: *{`operations.GetPlaylistContentsMetadata[]`}* +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Joss Whedon"}],"Genre":[{"tag":"Science Fiction"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Nathan Fillion"}],"Writer":[{"tag":"Joss Whedon"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141416,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","titleSort":"Amazing Spider-Man 2","type":"movie","updatedAt":1705637165,"year":2005}]` + + import('/content/types/models/operations/get_playlist_contents_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_metadata/go.mdx b/content/types/models/operations/get_playlist_contents_metadata/go.mdx new file mode 100644 index 0000000..cc06f3c --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_metadata/go.mdx @@ -0,0 +1,182 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `RatingKey` *{`*string`}* +
+**Example:** `17` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/17` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `Studio` *{`*string`}* +
+**Example:** `Universal Pictures` + +--- +##### `Type` *{`*string`}* +
+**Example:** `movie` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Serenity` + +--- +##### `TitleSort` *{`*string`}* +
+**Example:** `Amazing Spider-Man 2` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Movies` + +--- +##### `LibrarySectionID` *{`*int`}* +
+**Example:** `1` + +--- +##### `LibrarySectionKey` *{`*string`}* +
+**Example:** `/library/sections/1` + +--- +##### `ContentRating` *{`*string`}* +
+**Example:** `PG-13` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `Rating` *{`*float64`}* +
+**Example:** `8.2` + +--- +##### `AudienceRating` *{`*float64`}* +
+**Example:** `9.1` + +--- +##### `Year` *{`*int`}* +
+**Example:** `2005` + +--- +##### `Tagline` *{`*string`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141416` + +--- +##### `OriginallyAvailableAt` *{`*types.Date`}* +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705637164` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705637165` + +--- +##### `AudienceRatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `HasPremiumExtras` *{`*string`}* +
+**Example:** `1` + +--- +##### `HasPremiumPrimaryExtra` *{`*string`}* +
+**Example:** `1` + +--- +##### `RatingImage` *{`*string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `Media` *{`[]operations.GetPlaylistContentsMedia`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_playlist_contents_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Genre` *{`[]operations.GetPlaylistContentsGenre`}* +
+**Example:** `[{"tag":"Action"}]` + + import('/content/types/models/operations/get_playlist_contents_genre/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Country` *{`[]operations.GetPlaylistContentsCountry`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_playlist_contents_country/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Director` *{`[]operations.GetPlaylistContentsDirector`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_director/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Writer` *{`[]operations.GetPlaylistContentsWriter`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_writer/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Role` *{`[]operations.GetPlaylistContentsRole`}* +
+**Example:** `[{"tag":"Gina Torres"}]` + + import('/content/types/models/operations/get_playlist_contents_role/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_metadata/python.mdx b/content/types/models/operations/get_playlist_contents_metadata/python.mdx new file mode 100644 index 0000000..b0f3c52 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_metadata/python.mdx @@ -0,0 +1,182 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `17` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio` *{`Optional[str]`}* +
+**Example:** `Universal Pictures` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `movie` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Serenity` + +--- +##### `title_sort` *{`Optional[str]`}* +
+**Example:** `Amazing Spider-Man 2` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Movies` + +--- +##### `library_section_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `library_section_key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1` + +--- +##### `content_rating` *{`Optional[str]`}* +
+**Example:** `PG-13` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating` *{`Optional[float]`}* +
+**Example:** `8.2` + +--- +##### `audience_rating` *{`Optional[float]`}* +
+**Example:** `9.1` + +--- +##### `year` *{`Optional[int]`}* +
+**Example:** `2005` + +--- +##### `tagline` *{`Optional[str]`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141416` + +--- +##### `originally_available_at` [*{ `datetime` }*](https://docs.python.org/3/library/datetime.html#datetime-objects) +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705637164` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705637165` + +--- +##### `audience_rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `has_premium_extras` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `has_premium_primary_extra` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `rating_image` *{`Optional[str]`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` *{`List[operations.GetPlaylistContentsMedia]`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_playlist_contents_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre` *{`List[operations.GetPlaylistContentsGenre]`}* +
+**Example:** `[{"tag":"Action"}]` + + import('/content/types/models/operations/get_playlist_contents_genre/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country` *{`List[operations.GetPlaylistContentsCountry]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_playlist_contents_country/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director` *{`List[operations.GetPlaylistContentsDirector]`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_director/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer` *{`List[operations.GetPlaylistContentsWriter]`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_writer/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role` *{`List[operations.GetPlaylistContentsRole]`}* +
+**Example:** `[{"tag":"Gina Torres"}]` + + import('/content/types/models/operations/get_playlist_contents_role/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_metadata/typescript.mdx b/content/types/models/operations/get_playlist_contents_metadata/typescript.mdx new file mode 100644 index 0000000..5829a61 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_metadata/typescript.mdx @@ -0,0 +1,182 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ratingKey?`: *{`string`}* +
+**Example:** `17` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/17` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio?`: *{`string`}* +
+**Example:** `Universal Pictures` + +--- +##### `type?`: *{`string`}* +
+**Example:** `movie` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Serenity` + +--- +##### `titleSort?`: *{`string`}* +
+**Example:** `Amazing Spider-Man 2` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Movies` + +--- +##### `librarySectionID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `librarySectionKey?`: *{`string`}* +
+**Example:** `/library/sections/1` + +--- +##### `contentRating?`: *{`string`}* +
+**Example:** `PG-13` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating?`: *{`number`}* +
+**Example:** `8.2` + +--- +##### `audienceRating?`: *{`number`}* +
+**Example:** `9.1` + +--- +##### `year?`: *{`number`}* +
+**Example:** `2005` + +--- +##### `tagline?`: *{`string`}* +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141416` + +--- +##### `originallyAvailableAt?`: *{`RFCDate`}* +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705637164` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705637165` + +--- +##### `audienceRatingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `hasPremiumExtras?`: *{`string`}* +
+**Example:** `1` + +--- +##### `hasPremiumPrimaryExtra?`: *{`string`}* +
+**Example:** `1` + +--- +##### `ratingImage?`: *{`string`}* +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media?`: *{`operations.GetPlaylistContentsMedia[]`}* +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + + import('/content/types/models/operations/get_playlist_contents_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `genre?`: *{`operations.GetPlaylistContentsGenre[]`}* +
+**Example:** `[{"tag":"Action"}]` + + import('/content/types/models/operations/get_playlist_contents_genre/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `country?`: *{`operations.GetPlaylistContentsCountry[]`}* +
+**Example:** `[{"tag":"United States of America"}]` + + import('/content/types/models/operations/get_playlist_contents_country/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `director?`: *{`operations.GetPlaylistContentsDirector[]`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_director/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `writer?`: *{`operations.GetPlaylistContentsWriter[]`}* +
+**Example:** `[{"tag":"Joss Whedon"}]` + + import('/content/types/models/operations/get_playlist_contents_writer/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `role?`: *{`operations.GetPlaylistContentsRole[]`}* +
+**Example:** `[{"tag":"Gina Torres"}]` + + import('/content/types/models/operations/get_playlist_contents_role/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_part/go.mdx b/content/types/models/operations/get_playlist_contents_part/go.mdx new file mode 100644 index 0000000..5a732fa --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_part/go.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `15` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `141416` + +--- +##### `File` *{`*string`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `Size` *{`*int`}* +
+**Example:** `40271948` + +--- +##### `AudioProfile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `Container` *{`*string`}* +
+**Example:** `mp4` + +--- +##### `Has64bitOffsets` *{`*bool`}* +
+**Example:** `false` + +--- +##### `OptimizedForStreaming` *{`*bool`}* +
+**Example:** `false` + +--- +##### `VideoProfile` *{`*string`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_playlist_contents_part/python.mdx b/content/types/models/operations/get_playlist_contents_part/python.mdx new file mode 100644 index 0000000..13a583f --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_part/python.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `15` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `141416` + +--- +##### `file` *{`Optional[str]`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `40271948` + +--- +##### `audio_profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `mp4` + +--- +##### `has64bit_offsets` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `optimized_for_streaming` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `video_profile` *{`Optional[str]`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_playlist_contents_part/typescript.mdx b/content/types/models/operations/get_playlist_contents_part/typescript.mdx new file mode 100644 index 0000000..7e2310e --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_part/typescript.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `15` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `141416` + +--- +##### `file?`: *{`string`}* +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size?`: *{`number`}* +
+**Example:** `40271948` + +--- +##### `audioProfile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `container?`: *{`string`}* +
+**Example:** `mp4` + +--- +##### `has64bitOffsets?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `optimizedForStreaming?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `videoProfile?`: *{`string`}* +
+**Example:** `high` + + diff --git a/content/types/models/operations/get_playlist_contents_response/go.mdx b/content/types/models/operations/get_playlist_contents_response/go.mdx index 3b4ae5c..030a57f 100644 --- a/content/types/models/operations/get_playlist_contents_response/go.mdx +++ b/content/types/models/operations/get_playlist_contents_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetPlaylistContentsResponseBody`}* +The playlist contents + + import('/content/types/models/operations/get_playlist_contents_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_contents_response/python.mdx b/content/types/models/operations/get_playlist_contents_response/python.mdx index 93ee0a0..9728fda 100644 --- a/content/types/models/operations/get_playlist_contents_response/python.mdx +++ b/content/types/models/operations/get_playlist_contents_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetPlaylistContentsResponseBody]`}* +The playlist contents + + import('/content/types/models/operations/get_playlist_contents_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_contents_response/typescript.mdx b/content/types/models/operations/get_playlist_contents_response/typescript.mdx index 2035a36..525d7ec 100644 --- a/content/types/models/operations/get_playlist_contents_response/typescript.mdx +++ b/content/types/models/operations/get_playlist_contents_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetPlaylistContentsResponseBody`}* +The playlist contents + + import('/content/types/models/operations/get_playlist_contents_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_contents_response_body/go.mdx b/content/types/models/operations/get_playlist_contents_response_body/go.mdx new file mode 100644 index 0000000..d4cd137 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetPlaylistContentsMediaContainer`}* + + import('/content/types/models/operations/get_playlist_contents_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_response_body/python.mdx b/content/types/models/operations/get_playlist_contents_response_body/python.mdx new file mode 100644 index 0000000..b527e81 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetPlaylistContentsMediaContainer]`}* + + import('/content/types/models/operations/get_playlist_contents_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_response_body/typescript.mdx b/content/types/models/operations/get_playlist_contents_response_body/typescript.mdx new file mode 100644 index 0000000..662a707 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetPlaylistContentsMediaContainer`}* + + import('/content/types/models/operations/get_playlist_contents_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_contents_role/go.mdx b/content/types/models/operations/get_playlist_contents_role/go.mdx new file mode 100644 index 0000000..44a5db3 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_role/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Gina Torres` + + diff --git a/content/types/models/operations/get_playlist_contents_role/python.mdx b/content/types/models/operations/get_playlist_contents_role/python.mdx new file mode 100644 index 0000000..dd1088f --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_role/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Gina Torres` + + diff --git a/content/types/models/operations/get_playlist_contents_role/typescript.mdx b/content/types/models/operations/get_playlist_contents_role/typescript.mdx new file mode 100644 index 0000000..1e10fe8 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_role/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Gina Torres` + + diff --git a/content/types/models/operations/get_playlist_contents_writer/go.mdx b/content/types/models/operations/get_playlist_contents_writer/go.mdx new file mode 100644 index 0000000..cbcae12 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_writer/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Tag` *{`*string`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_contents_writer/python.mdx b/content/types/models/operations/get_playlist_contents_writer/python.mdx new file mode 100644 index 0000000..076a7a4 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_writer/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` *{`Optional[str]`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_contents_writer/typescript.mdx b/content/types/models/operations/get_playlist_contents_writer/typescript.mdx new file mode 100644 index 0000000..e4f5625 --- /dev/null +++ b/content/types/models/operations/get_playlist_contents_writer/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag?`: *{`string`}* +
+**Example:** `Joss Whedon` + + diff --git a/content/types/models/operations/get_playlist_media_container/go.mdx b/content/types/models/operations/get_playlist_media_container/go.mdx new file mode 100644 index 0000000..9b9e6e1 --- /dev/null +++ b/content/types/models/operations/get_playlist_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `1` + +--- +##### `Metadata` *{`[]operations.GetPlaylistMetadata`}* +
+**Example:** `[{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}]` + + import('/content/types/models/operations/get_playlist_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_media_container/python.mdx b/content/types/models/operations/get_playlist_media_container/python.mdx new file mode 100644 index 0000000..5dcd2fd --- /dev/null +++ b/content/types/models/operations/get_playlist_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `metadata` *{`List[operations.GetPlaylistMetadata]`}* +
+**Example:** `[{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}]` + + import('/content/types/models/operations/get_playlist_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_media_container/typescript.mdx b/content/types/models/operations/get_playlist_media_container/typescript.mdx new file mode 100644 index 0000000..ea9839f --- /dev/null +++ b/content/types/models/operations/get_playlist_media_container/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `1` + +--- +##### `metadata?`: *{`operations.GetPlaylistMetadata[]`}* +
+**Example:** `[{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}]` + + import('/content/types/models/operations/get_playlist_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_metadata/go.mdx b/content/types/models/operations/get_playlist_metadata/go.mdx new file mode 100644 index 0000000..dcfa6cf --- /dev/null +++ b/content/types/models/operations/get_playlist_metadata/go.mdx @@ -0,0 +1,74 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Content` *{`*string`}* +
+**Example:** `library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1` + +--- +##### `RatingKey` *{`*string`}* +
+**Example:** `95` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/95/items` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `Summary` *{`*string`}* + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `true` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/95/composite/1705717387` + +--- +##### `Icon` *{`*string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `282000` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `2` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705716493` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705717387` + + diff --git a/content/types/models/operations/get_playlist_metadata/python.mdx b/content/types/models/operations/get_playlist_metadata/python.mdx new file mode 100644 index 0000000..e7ee764 --- /dev/null +++ b/content/types/models/operations/get_playlist_metadata/python.mdx @@ -0,0 +1,74 @@ +{/* Autogenerated DO NOT EDIT */} +##### `content` *{`Optional[str]`}* +
+**Example:** `library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1` + +--- +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `95` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/95/items` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `summary` *{`Optional[str]`}* + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/95/composite/1705717387` + +--- +##### `icon` *{`Optional[str]`}* +
+**Example:** `playlist://image.smart` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `282000` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705716493` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705717387` + + diff --git a/content/types/models/operations/get_playlist_metadata/typescript.mdx b/content/types/models/operations/get_playlist_metadata/typescript.mdx new file mode 100644 index 0000000..4d45b3d --- /dev/null +++ b/content/types/models/operations/get_playlist_metadata/typescript.mdx @@ -0,0 +1,74 @@ +{/* Autogenerated DO NOT EDIT */} +##### `content?`: *{`string`}* +
+**Example:** `library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1` + +--- +##### `ratingKey?`: *{`string`}* +
+**Example:** `95` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/95/items` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Smart Movie Playlist` + +--- +##### `summary?`: *{`string`}* + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/95/composite/1705717387` + +--- +##### `icon?`: *{`string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `282000` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `2` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705716493` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705717387` + + diff --git a/content/types/models/operations/get_playlist_response/go.mdx b/content/types/models/operations/get_playlist_response/go.mdx index 3b4ae5c..b048b6b 100644 --- a/content/types/models/operations/get_playlist_response/go.mdx +++ b/content/types/models/operations/get_playlist_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetPlaylistResponseBody`}* +The playlist + + import('/content/types/models/operations/get_playlist_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_response/python.mdx b/content/types/models/operations/get_playlist_response/python.mdx index 93ee0a0..8e6e81d 100644 --- a/content/types/models/operations/get_playlist_response/python.mdx +++ b/content/types/models/operations/get_playlist_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetPlaylistResponseBody]`}* +The playlist + + import('/content/types/models/operations/get_playlist_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_response/typescript.mdx b/content/types/models/operations/get_playlist_response/typescript.mdx index 2035a36..c88d259 100644 --- a/content/types/models/operations/get_playlist_response/typescript.mdx +++ b/content/types/models/operations/get_playlist_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetPlaylistResponseBody`}* +The playlist + + import('/content/types/models/operations/get_playlist_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlist_response_body/go.mdx b/content/types/models/operations/get_playlist_response_body/go.mdx new file mode 100644 index 0000000..bffb985 --- /dev/null +++ b/content/types/models/operations/get_playlist_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetPlaylistMediaContainer`}* + + import('/content/types/models/operations/get_playlist_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_response_body/python.mdx b/content/types/models/operations/get_playlist_response_body/python.mdx new file mode 100644 index 0000000..026e54b --- /dev/null +++ b/content/types/models/operations/get_playlist_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetPlaylistMediaContainer]`}* + + import('/content/types/models/operations/get_playlist_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlist_response_body/typescript.mdx b/content/types/models/operations/get_playlist_response_body/typescript.mdx new file mode 100644 index 0000000..0314f7d --- /dev/null +++ b/content/types/models/operations/get_playlist_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetPlaylistMediaContainer`}* + + import('/content/types/models/operations/get_playlist_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_media_container/go.mdx b/content/types/models/operations/get_playlists_media_container/go.mdx new file mode 100644 index 0000000..f072885 --- /dev/null +++ b/content/types/models/operations/get_playlists_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `4` + +--- +##### `Metadata` *{`[]operations.GetPlaylistsMetadata`}* +
+**Example:** `[{"addedAt":1705716298,"composite":"/playlists/92/composite/1705716440","duration":7328000,"guid":"com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903","icon":"playlist://image.smart","key":"/playlists/92/items","lastViewedAt":1705716298,"leafCount":32,"playlistType":"video","ratingKey":"92","smart":false,"summary":"A Great Playlist","title":"Static Playlist","type":"playlist","updatedAt":1705716440,"viewCount":1}]` + + import('/content/types/models/operations/get_playlists_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_media_container/python.mdx b/content/types/models/operations/get_playlists_media_container/python.mdx new file mode 100644 index 0000000..e45e404 --- /dev/null +++ b/content/types/models/operations/get_playlists_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `4` + +--- +##### `metadata` *{`List[operations.GetPlaylistsMetadata]`}* +
+**Example:** `[{"addedAt":1705716298,"composite":"/playlists/92/composite/1705716440","duration":7328000,"guid":"com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903","icon":"playlist://image.smart","key":"/playlists/92/items","lastViewedAt":1705716298,"leafCount":32,"playlistType":"video","ratingKey":"92","smart":false,"summary":"A Great Playlist","title":"Static Playlist","type":"playlist","updatedAt":1705716440,"viewCount":1}]` + + import('/content/types/models/operations/get_playlists_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_media_container/typescript.mdx b/content/types/models/operations/get_playlists_media_container/typescript.mdx new file mode 100644 index 0000000..dd47edb --- /dev/null +++ b/content/types/models/operations/get_playlists_media_container/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `4` + +--- +##### `metadata?`: *{`operations.GetPlaylistsMetadata[]`}* +
+**Example:** `[{"addedAt":1705716298,"composite":"/playlists/92/composite/1705716440","duration":7328000,"guid":"com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903","icon":"playlist://image.smart","key":"/playlists/92/items","lastViewedAt":1705716298,"leafCount":32,"playlistType":"video","ratingKey":"92","smart":false,"summary":"A Great Playlist","title":"Static Playlist","type":"playlist","updatedAt":1705716440,"viewCount":1}]` + + import('/content/types/models/operations/get_playlists_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_metadata/go.mdx b/content/types/models/operations/get_playlists_metadata/go.mdx new file mode 100644 index 0000000..98fb40f --- /dev/null +++ b/content/types/models/operations/get_playlists_metadata/go.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `92` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/92/items` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Static Playlist` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `A Great Playlist` + +--- +##### `Smart` *{`*bool`}* +
+**Example:** `false` + +--- +##### `PlaylistType` *{`*string`}* +
+**Example:** `video` + +--- +##### `Composite` *{`*string`}* +
+**Example:** `/playlists/92/composite/1705716440` + +--- +##### `Icon` *{`*string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `ViewCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `LastViewedAt` *{`*int`}* +
+**Example:** `1705716298` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `7328000` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `32` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705716298` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705716440` + + diff --git a/content/types/models/operations/get_playlists_metadata/python.mdx b/content/types/models/operations/get_playlists_metadata/python.mdx new file mode 100644 index 0000000..27d8fe3 --- /dev/null +++ b/content/types/models/operations/get_playlists_metadata/python.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `92` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/92/items` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Static Playlist` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `A Great Playlist` + +--- +##### `smart` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `playlist_type` *{`Optional[str]`}* +
+**Example:** `video` + +--- +##### `composite` *{`Optional[str]`}* +
+**Example:** `/playlists/92/composite/1705716440` + +--- +##### `icon` *{`Optional[str]`}* +
+**Example:** `playlist://image.smart` + +--- +##### `view_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `last_viewed_at` *{`Optional[int]`}* +
+**Example:** `1705716298` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `7328000` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `32` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705716298` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705716440` + + diff --git a/content/types/models/operations/get_playlists_metadata/typescript.mdx b/content/types/models/operations/get_playlists_metadata/typescript.mdx new file mode 100644 index 0000000..063bddd --- /dev/null +++ b/content/types/models/operations/get_playlists_metadata/typescript.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `92` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/92/items` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Static Playlist` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `A Great Playlist` + +--- +##### `smart?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `playlistType?`: *{`string`}* +
+**Example:** `video` + +--- +##### `composite?`: *{`string`}* +
+**Example:** `/playlists/92/composite/1705716440` + +--- +##### `icon?`: *{`string`}* +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `lastViewedAt?`: *{`number`}* +
+**Example:** `1705716298` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `7328000` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `32` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705716298` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705716440` + + diff --git a/content/types/models/operations/get_playlists_response/go.mdx b/content/types/models/operations/get_playlists_response/go.mdx index 3b4ae5c..4fd6921 100644 --- a/content/types/models/operations/get_playlists_response/go.mdx +++ b/content/types/models/operations/get_playlists_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetPlaylistsResponseBody`}* +returns all playlists + + import('/content/types/models/operations/get_playlists_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlists_response/python.mdx b/content/types/models/operations/get_playlists_response/python.mdx index 93ee0a0..018b43d 100644 --- a/content/types/models/operations/get_playlists_response/python.mdx +++ b/content/types/models/operations/get_playlists_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetPlaylistsResponseBody]`}* +returns all playlists + + import('/content/types/models/operations/get_playlists_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlists_response/typescript.mdx b/content/types/models/operations/get_playlists_response/typescript.mdx index 2035a36..0a7e5c8 100644 --- a/content/types/models/operations/get_playlists_response/typescript.mdx +++ b/content/types/models/operations/get_playlists_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetPlaylistsResponseBody`}* +returns all playlists + + import('/content/types/models/operations/get_playlists_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_playlists_response_body/go.mdx b/content/types/models/operations/get_playlists_response_body/go.mdx new file mode 100644 index 0000000..9d5deb7 --- /dev/null +++ b/content/types/models/operations/get_playlists_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetPlaylistsMediaContainer`}* + + import('/content/types/models/operations/get_playlists_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_response_body/python.mdx b/content/types/models/operations/get_playlists_response_body/python.mdx new file mode 100644 index 0000000..697489c --- /dev/null +++ b/content/types/models/operations/get_playlists_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetPlaylistsMediaContainer]`}* + + import('/content/types/models/operations/get_playlists_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_playlists_response_body/typescript.mdx b/content/types/models/operations/get_playlists_response_body/typescript.mdx new file mode 100644 index 0000000..6a61eea --- /dev/null +++ b/content/types/models/operations/get_playlists_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetPlaylistsMediaContainer`}* + + import('/content/types/models/operations/get_playlists_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_server_identity_response/go.mdx b/content/types/models/operations/get_server_identity_response/go.mdx index 366c273..544d093 100644 --- a/content/types/models/operations/get_server_identity_response/go.mdx +++ b/content/types/models/operations/get_server_identity_response/go.mdx @@ -15,7 +15,7 @@ Raw HTTP response; suitable for custom response parsing --- ##### `Object` *{`*operations.GetServerIdentityResponseBody`}* -The Transcode Sessions +The Server Identity information import('/content/types/models/operations/get_server_identity_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_server_identity_response/python.mdx b/content/types/models/operations/get_server_identity_response/python.mdx index 3d67064..e78fd8c 100644 --- a/content/types/models/operations/get_server_identity_response/python.mdx +++ b/content/types/models/operations/get_server_identity_response/python.mdx @@ -15,7 +15,7 @@ Raw HTTP response; suitable for custom response parsing --- ##### `object` *{`Optional[operations.GetServerIdentityResponseBody]`}* -The Transcode Sessions +The Server Identity information import('/content/types/models/operations/get_server_identity_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_server_identity_response/typescript.mdx b/content/types/models/operations/get_server_identity_response/typescript.mdx index 5b79281..d4b6c7a 100644 --- a/content/types/models/operations/get_server_identity_response/typescript.mdx +++ b/content/types/models/operations/get_server_identity_response/typescript.mdx @@ -15,7 +15,7 @@ Raw HTTP response; suitable for custom response parsing --- ##### `object?`: *{`operations.GetServerIdentityResponseBody`}* -The Transcode Sessions +The Server Identity information import('/content/types/models/operations/get_server_identity_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_server_preferences_media_container/go.mdx b/content/types/models/operations/get_server_preferences_media_container/go.mdx new file mode 100644 index 0000000..6e2eb2b --- /dev/null +++ b/content/types/models/operations/get_server_preferences_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `161` + +--- +##### `Setting` *{`[]operations.Setting`}* +
+**Example:** `[{"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}]` + + import('/content/types/models/operations/setting/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_server_preferences_media_container/python.mdx b/content/types/models/operations/get_server_preferences_media_container/python.mdx new file mode 100644 index 0000000..4eabba5 --- /dev/null +++ b/content/types/models/operations/get_server_preferences_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `161` + +--- +##### `setting` *{`List[Union[operations.One, operations.Two]]`}* +
+**Example:** `[{"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}]` + + import('/content/types/models/operations/setting/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_server_preferences_media_container/typescript.mdx b/content/types/models/operations/get_server_preferences_media_container/typescript.mdx new file mode 100644 index 0000000..2e37621 --- /dev/null +++ b/content/types/models/operations/get_server_preferences_media_container/typescript.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size?`: *{`number`}* +
+**Example:** `161` + +--- +##### `setting?`: *{`*operations.Setting*[]`}* +
+**Example:** `[{"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}]` + + diff --git a/content/types/models/operations/get_server_preferences_response/go.mdx b/content/types/models/operations/get_server_preferences_response/go.mdx index 3b4ae5c..d99d225 100644 --- a/content/types/models/operations/get_server_preferences_response/go.mdx +++ b/content/types/models/operations/get_server_preferences_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetServerPreferencesResponseBody`}* +Server Preferences + + import('/content/types/models/operations/get_server_preferences_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_server_preferences_response/python.mdx b/content/types/models/operations/get_server_preferences_response/python.mdx index 93ee0a0..16b04dd 100644 --- a/content/types/models/operations/get_server_preferences_response/python.mdx +++ b/content/types/models/operations/get_server_preferences_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetServerPreferencesResponseBody]`}* +Server Preferences + + import('/content/types/models/operations/get_server_preferences_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_server_preferences_response/typescript.mdx b/content/types/models/operations/get_server_preferences_response/typescript.mdx index 2035a36..458769b 100644 --- a/content/types/models/operations/get_server_preferences_response/typescript.mdx +++ b/content/types/models/operations/get_server_preferences_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetServerPreferencesResponseBody`}* +Server Preferences + + import('/content/types/models/operations/get_server_preferences_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_server_preferences_response_body/go.mdx b/content/types/models/operations/get_server_preferences_response_body/go.mdx new file mode 100644 index 0000000..e63430e --- /dev/null +++ b/content/types/models/operations/get_server_preferences_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetServerPreferencesMediaContainer`}* + + import('/content/types/models/operations/get_server_preferences_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_server_preferences_response_body/python.mdx b/content/types/models/operations/get_server_preferences_response_body/python.mdx new file mode 100644 index 0000000..24bfeda --- /dev/null +++ b/content/types/models/operations/get_server_preferences_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetServerPreferencesMediaContainer]`}* + + import('/content/types/models/operations/get_server_preferences_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_server_preferences_response_body/typescript.mdx b/content/types/models/operations/get_server_preferences_response_body/typescript.mdx new file mode 100644 index 0000000..9067131 --- /dev/null +++ b/content/types/models/operations/get_server_preferences_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetServerPreferencesMediaContainer`}* + + import('/content/types/models/operations/get_server_preferences_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_media_container/go.mdx b/content/types/models/operations/get_session_history_media_container/go.mdx new file mode 100644 index 0000000..bd0149a --- /dev/null +++ b/content/types/models/operations/get_session_history_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `10855` + +--- +##### `Metadata` *{`[]operations.GetSessionHistoryMetadata`}* +
+**Example:** `[{"accountID":1,"deviceID":5,"grandparentArt":"/library/metadata/32132/art/1703933346","grandparentKey":"/library/metadata/32132","grandparentThumb":"/library/metadata/32132/thumb/1703933346","grandparentTitle":"Taskmaster","historyKey":"/status/sessions/history/1","index":1,"key":"/library/metadata/32171","librarySectionID":"2","originallyAvailableAt":"2022-04-14T00:00:00Z","parentIndex":13,"parentKey":"/library/metadata/32170","parentThumb":"/library/metadata/32170/thumb/1654134301","ratingKey":"32171","thumb":"/library/metadata/32171/thumb/-1","title":"The Noise That Blue Makes","type":"episode","viewedAt":1654139223}]` + + import('/content/types/models/operations/get_session_history_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_media_container/python.mdx b/content/types/models/operations/get_session_history_media_container/python.mdx new file mode 100644 index 0000000..19ea770 --- /dev/null +++ b/content/types/models/operations/get_session_history_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `10855` + +--- +##### `metadata` *{`List[operations.GetSessionHistoryMetadata]`}* +
+**Example:** `[{"accountID":1,"deviceID":5,"grandparentArt":"/library/metadata/32132/art/1703933346","grandparentKey":"/library/metadata/32132","grandparentThumb":"/library/metadata/32132/thumb/1703933346","grandparentTitle":"Taskmaster","historyKey":"/status/sessions/history/1","index":1,"key":"/library/metadata/32171","librarySectionID":"2","originallyAvailableAt":"2022-04-14T00:00:00Z","parentIndex":13,"parentKey":"/library/metadata/32170","parentThumb":"/library/metadata/32170/thumb/1654134301","ratingKey":"32171","thumb":"/library/metadata/32171/thumb/-1","title":"The Noise That Blue Makes","type":"episode","viewedAt":1654139223}]` + + import('/content/types/models/operations/get_session_history_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_media_container/typescript.mdx b/content/types/models/operations/get_session_history_media_container/typescript.mdx new file mode 100644 index 0000000..64f798b --- /dev/null +++ b/content/types/models/operations/get_session_history_media_container/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `10855` + +--- +##### `metadata?`: *{`operations.GetSessionHistoryMetadata[]`}* +
+**Example:** `[{"accountID":1,"deviceID":5,"grandparentArt":"/library/metadata/32132/art/1703933346","grandparentKey":"/library/metadata/32132","grandparentThumb":"/library/metadata/32132/thumb/1703933346","grandparentTitle":"Taskmaster","historyKey":"/status/sessions/history/1","index":1,"key":"/library/metadata/32171","librarySectionID":"2","originallyAvailableAt":"2022-04-14T00:00:00Z","parentIndex":13,"parentKey":"/library/metadata/32170","parentThumb":"/library/metadata/32170/thumb/1654134301","ratingKey":"32171","thumb":"/library/metadata/32171/thumb/-1","title":"The Noise That Blue Makes","type":"episode","viewedAt":1654139223}]` + + import('/content/types/models/operations/get_session_history_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_metadata/go.mdx b/content/types/models/operations/get_session_history_metadata/go.mdx new file mode 100644 index 0000000..8646a56 --- /dev/null +++ b/content/types/models/operations/get_session_history_metadata/go.mdx @@ -0,0 +1,96 @@ +{/* Autogenerated DO NOT EDIT */} +##### `HistoryKey` *{`*string`}* +
+**Example:** `/status/sessions/history/1` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/32171` + +--- +##### `RatingKey` *{`*string`}* +
+**Example:** `32171` + +--- +##### `LibrarySectionID` *{`*string`}* +
+**Example:** `2` + +--- +##### `ParentKey` *{`*string`}* +
+**Example:** `/library/metadata/32170` + +--- +##### `GrandparentKey` *{`*string`}* +
+**Example:** `/library/metadata/32132` + +--- +##### `Title` *{`*string`}* +
+**Example:** `The Noise That Blue Makes` + +--- +##### `GrandparentTitle` *{`*string`}* +
+**Example:** `Taskmaster` + +--- +##### `Type` *{`*string`}* +
+**Example:** `episode` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/32171/thumb/-1` + +--- +##### `ParentThumb` *{`*string`}* +
+**Example:** `/library/metadata/32170/thumb/1654134301` + +--- +##### `GrandparentThumb` *{`*string`}* +
+**Example:** `/library/metadata/32132/thumb/1703933346` + +--- +##### `GrandparentArt` *{`*string`}* +
+**Example:** `/library/metadata/32132/art/1703933346` + +--- +##### `Index` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `13` + +--- +##### `OriginallyAvailableAt` *{`*types.Date`}* +
+**Example:** `2022-04-14 00:00:00 +0000 UTC` + +--- +##### `ViewedAt` *{`*int`}* +
+**Example:** `1654139223` + +--- +##### `AccountID` *{`*int`}* +
+**Example:** `1` + +--- +##### `DeviceID` *{`*int`}* +
+**Example:** `5` + + diff --git a/content/types/models/operations/get_session_history_metadata/python.mdx b/content/types/models/operations/get_session_history_metadata/python.mdx new file mode 100644 index 0000000..7993dee --- /dev/null +++ b/content/types/models/operations/get_session_history_metadata/python.mdx @@ -0,0 +1,96 @@ +{/* Autogenerated DO NOT EDIT */} +##### `history_key` *{`Optional[str]`}* +
+**Example:** `/status/sessions/history/1` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32171` + +--- +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `32171` + +--- +##### `library_section_id` *{`Optional[str]`}* +
+**Example:** `2` + +--- +##### `parent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32170` + +--- +##### `grandparent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32132` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `The Noise That Blue Makes` + +--- +##### `grandparent_title` *{`Optional[str]`}* +
+**Example:** `Taskmaster` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `episode` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32171/thumb/-1` + +--- +##### `parent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32170/thumb/1654134301` + +--- +##### `grandparent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32132/thumb/1703933346` + +--- +##### `grandparent_art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/32132/art/1703933346` + +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `13` + +--- +##### `originally_available_at` [*{ `datetime` }*](https://docs.python.org/3/library/datetime.html#datetime-objects) +
+**Example:** `2022-04-14 00:00:00 +0000 UTC` + +--- +##### `viewed_at` *{`Optional[int]`}* +
+**Example:** `1654139223` + +--- +##### `account_id` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `device_id` *{`Optional[int]`}* +
+**Example:** `5` + + diff --git a/content/types/models/operations/get_session_history_metadata/typescript.mdx b/content/types/models/operations/get_session_history_metadata/typescript.mdx new file mode 100644 index 0000000..f133d5f --- /dev/null +++ b/content/types/models/operations/get_session_history_metadata/typescript.mdx @@ -0,0 +1,96 @@ +{/* Autogenerated DO NOT EDIT */} +##### `historyKey?`: *{`string`}* +
+**Example:** `/status/sessions/history/1` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/32171` + +--- +##### `ratingKey?`: *{`string`}* +
+**Example:** `32171` + +--- +##### `librarySectionID?`: *{`string`}* +
+**Example:** `2` + +--- +##### `parentKey?`: *{`string`}* +
+**Example:** `/library/metadata/32170` + +--- +##### `grandparentKey?`: *{`string`}* +
+**Example:** `/library/metadata/32132` + +--- +##### `title?`: *{`string`}* +
+**Example:** `The Noise That Blue Makes` + +--- +##### `grandparentTitle?`: *{`string`}* +
+**Example:** `Taskmaster` + +--- +##### `type?`: *{`string`}* +
+**Example:** `episode` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/32171/thumb/-1` + +--- +##### `parentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/32170/thumb/1654134301` + +--- +##### `grandparentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/32132/thumb/1703933346` + +--- +##### `grandparentArt?`: *{`string`}* +
+**Example:** `/library/metadata/32132/art/1703933346` + +--- +##### `index?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `13` + +--- +##### `originallyAvailableAt?`: *{`RFCDate`}* +
+**Example:** `2022-04-14 00:00:00 +0000 UTC` + +--- +##### `viewedAt?`: *{`number`}* +
+**Example:** `1654139223` + +--- +##### `accountID?`: *{`number`}* +
+**Example:** `1` + +--- +##### `deviceID?`: *{`number`}* +
+**Example:** `5` + + diff --git a/content/types/models/operations/get_session_history_response/go.mdx b/content/types/models/operations/get_session_history_response/go.mdx index 3b4ae5c..fe1cdae 100644 --- a/content/types/models/operations/get_session_history_response/go.mdx +++ b/content/types/models/operations/get_session_history_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetSessionHistoryResponseBody`}* +List of Plex Sessions + + import('/content/types/models/operations/get_session_history_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_session_history_response/python.mdx b/content/types/models/operations/get_session_history_response/python.mdx index 93ee0a0..fa6b0c4 100644 --- a/content/types/models/operations/get_session_history_response/python.mdx +++ b/content/types/models/operations/get_session_history_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetSessionHistoryResponseBody]`}* +List of Plex Sessions + + import('/content/types/models/operations/get_session_history_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_session_history_response/typescript.mdx b/content/types/models/operations/get_session_history_response/typescript.mdx index 2035a36..69eacb6 100644 --- a/content/types/models/operations/get_session_history_response/typescript.mdx +++ b/content/types/models/operations/get_session_history_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetSessionHistoryResponseBody`}* +List of Plex Sessions + + import('/content/types/models/operations/get_session_history_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_session_history_response_body/go.mdx b/content/types/models/operations/get_session_history_response_body/go.mdx new file mode 100644 index 0000000..1aca16f --- /dev/null +++ b/content/types/models/operations/get_session_history_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetSessionHistoryMediaContainer`}* + + import('/content/types/models/operations/get_session_history_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_response_body/python.mdx b/content/types/models/operations/get_session_history_response_body/python.mdx new file mode 100644 index 0000000..63d2716 --- /dev/null +++ b/content/types/models/operations/get_session_history_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetSessionHistoryMediaContainer]`}* + + import('/content/types/models/operations/get_session_history_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_session_history_response_body/typescript.mdx b/content/types/models/operations/get_session_history_response_body/typescript.mdx new file mode 100644 index 0000000..ddb912b --- /dev/null +++ b/content/types/models/operations/get_session_history_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetSessionHistoryMediaContainer`}* + + import('/content/types/models/operations/get_session_history_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media/go.mdx b/content/types/models/operations/get_sessions_media/go.mdx new file mode 100644 index 0000000..0fb30b6 --- /dev/null +++ b/content/types/models/operations/get_sessions_media/go.mdx @@ -0,0 +1,47 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `AudioChannels` *{`*int`}* +
+**Example:** `2` + +--- +##### `AudioCodec` *{`*string`}* +
+**Example:** `flac` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `1014` + +--- +##### `Container` *{`*string`}* +
+**Example:** `flac` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `186240` + +--- +##### `ID` *{`*string`}* +
+**Example:** `130355` + +--- +##### `Selected` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Part` *{`[]operations.GetSessionsPart`}* +
+**Example:** `[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}]` + + import('/content/types/models/operations/get_sessions_part/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media/python.mdx b/content/types/models/operations/get_sessions_media/python.mdx new file mode 100644 index 0000000..4c1ddb5 --- /dev/null +++ b/content/types/models/operations/get_sessions_media/python.mdx @@ -0,0 +1,47 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `audio_channels` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `audio_codec` *{`Optional[str]`}* +
+**Example:** `flac` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `1014` + +--- +##### `container` *{`Optional[str]`}* +
+**Example:** `flac` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `186240` + +--- +##### `id` *{`Optional[str]`}* +
+**Example:** `130355` + +--- +##### `selected` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `part` *{`List[operations.GetSessionsPart]`}* +
+**Example:** `[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}]` + + import('/content/types/models/operations/get_sessions_part/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media/typescript.mdx b/content/types/models/operations/get_sessions_media/typescript.mdx new file mode 100644 index 0000000..0eacb00 --- /dev/null +++ b/content/types/models/operations/get_sessions_media/typescript.mdx @@ -0,0 +1,47 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `audioChannels?`: *{`number`}* +
+**Example:** `2` + +--- +##### `audioCodec?`: *{`string`}* +
+**Example:** `flac` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `1014` + +--- +##### `container?`: *{`string`}* +
+**Example:** `flac` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `186240` + +--- +##### `id?`: *{`string`}* +
+**Example:** `130355` + +--- +##### `selected?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `part?`: *{`operations.GetSessionsPart[]`}* +
+**Example:** `[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}]` + + import('/content/types/models/operations/get_sessions_part/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media_container/go.mdx b/content/types/models/operations/get_sessions_media_container/go.mdx new file mode 100644 index 0000000..eb5450f --- /dev/null +++ b/content/types/models/operations/get_sessions_media_container/go.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `1` + +--- +##### `Metadata` *{`[]operations.GetSessionsMetadata`}* +
+**Example:** `[{"Media":[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}],"Player":{"address":"10.10.10.171","local":true,"machineIdentifier":"3tsdzir85m2onc3qyr255aq1","model":"standalone","platform":"windows","platformVersion":"10.0.22621","product":"Plex for Windows","profile":"Plex Desktop","relayed":false,"remotePublicAddress":"68.248.140.20","secure":true,"state":"playing","title":"DESKTOP-BL80MTD","userID":1,"version":"1.85.0.4071-21128b56"},"Session":{"bandwidth":1050,"id":"93h7e00ncblxncqw9lkfaoxi","location":"lan"},"User":{"id":"1","thumb":"https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661","title":"Blindkitty38"},"addedAt":1705543312,"art":"/library/metadata/39904/art/1705310687","duration":186240,"grandparentArt":"/library/metadata/39904/art/1705310687","grandparentGuid":"plex://artist/5d07bbfd403c6402904a6480","grandparentKey":"/library/metadata/39904","grandparentRatingKey":"39904","grandparentThumb":"/library/metadata/39904/thumb/1705310687","grandparentTitle":"Green Day","guid":"plex://track/6535834f71f22f36f71a8e8f","index":1,"key":"/library/metadata/67085","librarySectionID":"3","librarySectionKey":"/library/sections/3","librarySectionTitle":"Music","musicAnalysisVersion":"1","parentGuid":"plex://album/65394d6d472b8ab03ef47f12","parentIndex":1,"parentKey":"/library/metadata/67084","parentRatingKey":"67084","parentStudio":"Reprise Records","parentThumb":"/library/metadata/67084/thumb/1705543314","parentTitle":"Saviors","parentYear":2024,"ratingCount":45885,"ratingKey":"67085","sessionKey":"203","thumb":"/library/metadata/67084/thumb/1705543314","title":"The American Dream Is Killing Me","titleSort":"American Dream Is Killing Me","type":"track","updatedAt":1705543314,"viewOffset":1000}]` + + import('/content/types/models/operations/get_sessions_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media_container/python.mdx b/content/types/models/operations/get_sessions_media_container/python.mdx new file mode 100644 index 0000000..ba20df7 --- /dev/null +++ b/content/types/models/operations/get_sessions_media_container/python.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `metadata` *{`List[operations.GetSessionsMetadata]`}* +
+**Example:** `[{"Media":[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}],"Player":{"address":"10.10.10.171","local":true,"machineIdentifier":"3tsdzir85m2onc3qyr255aq1","model":"standalone","platform":"windows","platformVersion":"10.0.22621","product":"Plex for Windows","profile":"Plex Desktop","relayed":false,"remotePublicAddress":"68.248.140.20","secure":true,"state":"playing","title":"DESKTOP-BL80MTD","userID":1,"version":"1.85.0.4071-21128b56"},"Session":{"bandwidth":1050,"id":"93h7e00ncblxncqw9lkfaoxi","location":"lan"},"User":{"id":"1","thumb":"https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661","title":"Blindkitty38"},"addedAt":1705543312,"art":"/library/metadata/39904/art/1705310687","duration":186240,"grandparentArt":"/library/metadata/39904/art/1705310687","grandparentGuid":"plex://artist/5d07bbfd403c6402904a6480","grandparentKey":"/library/metadata/39904","grandparentRatingKey":"39904","grandparentThumb":"/library/metadata/39904/thumb/1705310687","grandparentTitle":"Green Day","guid":"plex://track/6535834f71f22f36f71a8e8f","index":1,"key":"/library/metadata/67085","librarySectionID":"3","librarySectionKey":"/library/sections/3","librarySectionTitle":"Music","musicAnalysisVersion":"1","parentGuid":"plex://album/65394d6d472b8ab03ef47f12","parentIndex":1,"parentKey":"/library/metadata/67084","parentRatingKey":"67084","parentStudio":"Reprise Records","parentThumb":"/library/metadata/67084/thumb/1705543314","parentTitle":"Saviors","parentYear":2024,"ratingCount":45885,"ratingKey":"67085","sessionKey":"203","thumb":"/library/metadata/67084/thumb/1705543314","title":"The American Dream Is Killing Me","titleSort":"American Dream Is Killing Me","type":"track","updatedAt":1705543314,"viewOffset":1000}]` + + import('/content/types/models/operations/get_sessions_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_media_container/typescript.mdx b/content/types/models/operations/get_sessions_media_container/typescript.mdx new file mode 100644 index 0000000..84d41aa --- /dev/null +++ b/content/types/models/operations/get_sessions_media_container/typescript.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `1` + +--- +##### `metadata?`: *{`operations.GetSessionsMetadata[]`}* +
+**Example:** `[{"Media":[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}],"Player":{"address":"10.10.10.171","local":true,"machineIdentifier":"3tsdzir85m2onc3qyr255aq1","model":"standalone","platform":"windows","platformVersion":"10.0.22621","product":"Plex for Windows","profile":"Plex Desktop","relayed":false,"remotePublicAddress":"68.248.140.20","secure":true,"state":"playing","title":"DESKTOP-BL80MTD","userID":1,"version":"1.85.0.4071-21128b56"},"Session":{"bandwidth":1050,"id":"93h7e00ncblxncqw9lkfaoxi","location":"lan"},"User":{"id":"1","thumb":"https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661","title":"Blindkitty38"},"addedAt":1705543312,"art":"/library/metadata/39904/art/1705310687","duration":186240,"grandparentArt":"/library/metadata/39904/art/1705310687","grandparentGuid":"plex://artist/5d07bbfd403c6402904a6480","grandparentKey":"/library/metadata/39904","grandparentRatingKey":"39904","grandparentThumb":"/library/metadata/39904/thumb/1705310687","grandparentTitle":"Green Day","guid":"plex://track/6535834f71f22f36f71a8e8f","index":1,"key":"/library/metadata/67085","librarySectionID":"3","librarySectionKey":"/library/sections/3","librarySectionTitle":"Music","musicAnalysisVersion":"1","parentGuid":"plex://album/65394d6d472b8ab03ef47f12","parentIndex":1,"parentKey":"/library/metadata/67084","parentRatingKey":"67084","parentStudio":"Reprise Records","parentThumb":"/library/metadata/67084/thumb/1705543314","parentTitle":"Saviors","parentYear":2024,"ratingCount":45885,"ratingKey":"67085","sessionKey":"203","thumb":"/library/metadata/67084/thumb/1705543314","title":"The American Dream Is Killing Me","titleSort":"American Dream Is Killing Me","type":"track","updatedAt":1705543314,"viewOffset":1000}]` + + import('/content/types/models/operations/get_sessions_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_metadata/go.mdx b/content/types/models/operations/get_sessions_metadata/go.mdx new file mode 100644 index 0000000..dc373a2 --- /dev/null +++ b/content/types/models/operations/get_sessions_metadata/go.mdx @@ -0,0 +1,195 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `AddedAt` *{`*int`}* +
+**Example:** `1705543312` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `186240` + +--- +##### `GrandparentArt` *{`*string`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `GrandparentGUID` *{`*string`}* +
+**Example:** `plex://artist/5d07bbfd403c6402904a6480` + +--- +##### `GrandparentKey` *{`*string`}* +
+**Example:** `/library/metadata/39904` + +--- +##### `GrandparentRatingKey` *{`*string`}* +
+**Example:** `39904` + +--- +##### `GrandparentThumb` *{`*string`}* +
+**Example:** `/library/metadata/39904/thumb/1705310687` + +--- +##### `GrandparentTitle` *{`*string`}* +
+**Example:** `Green Day` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://track/6535834f71f22f36f71a8e8f` + +--- +##### `Index` *{`*int`}* +
+**Example:** `1` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/67085` + +--- +##### `LibrarySectionID` *{`*string`}* +
+**Example:** `3` + +--- +##### `LibrarySectionKey` *{`*string`}* +
+**Example:** `/library/sections/3` + +--- +##### `LibrarySectionTitle` *{`*string`}* +
+**Example:** `Music` + +--- +##### `MusicAnalysisVersion` *{`*string`}* +
+**Example:** `1` + +--- +##### `ParentGUID` *{`*string`}* +
+**Example:** `plex://album/65394d6d472b8ab03ef47f12` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentKey` *{`*string`}* +
+**Example:** `/library/metadata/67084` + +--- +##### `ParentRatingKey` *{`*string`}* +
+**Example:** `67084` + +--- +##### `ParentStudio` *{`*string`}* +
+**Example:** `Reprise Records` + +--- +##### `ParentThumb` *{`*string`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `ParentTitle` *{`*string`}* +
+**Example:** `Saviors` + +--- +##### `ParentYear` *{`*int`}* +
+**Example:** `2024` + +--- +##### `RatingCount` *{`*int`}* +
+**Example:** `45885` + +--- +##### `RatingKey` *{`*string`}* +
+**Example:** `67085` + +--- +##### `SessionKey` *{`*string`}* +
+**Example:** `203` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `Title` *{`*string`}* +
+**Example:** `The American Dream Is Killing Me` + +--- +##### `TitleSort` *{`*string`}* +
+**Example:** `American Dream Is Killing Me` + +--- +##### `Type` *{`*string`}* +
+**Example:** `track` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705543314` + +--- +##### `ViewOffset` *{`*int`}* +
+**Example:** `1000` + +--- +##### `Media` *{`[]operations.GetSessionsMedia`}* +
+**Example:** `[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}]` + + import('/content/types/models/operations/get_sessions_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `User` *{`*operations.User`}* + + import('/content/types/models/operations/user/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Player` *{`*operations.Player`}* + + import('/content/types/models/operations/player/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `Session` *{`*operations.Session`}* + + import('/content/types/models/operations/session/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_metadata/python.mdx b/content/types/models/operations/get_sessions_metadata/python.mdx new file mode 100644 index 0000000..02ddf9c --- /dev/null +++ b/content/types/models/operations/get_sessions_metadata/python.mdx @@ -0,0 +1,195 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705543312` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `186240` + +--- +##### `grandparent_art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `grandparent_guid` *{`Optional[str]`}* +
+**Example:** `plex://artist/5d07bbfd403c6402904a6480` + +--- +##### `grandparent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/39904` + +--- +##### `grandparent_rating_key` *{`Optional[str]`}* +
+**Example:** `39904` + +--- +##### `grandparent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/39904/thumb/1705310687` + +--- +##### `grandparent_title` *{`Optional[str]`}* +
+**Example:** `Green Day` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://track/6535834f71f22f36f71a8e8f` + +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/67085` + +--- +##### `library_section_id` *{`Optional[str]`}* +
+**Example:** `3` + +--- +##### `library_section_key` *{`Optional[str]`}* +
+**Example:** `/library/sections/3` + +--- +##### `library_section_title` *{`Optional[str]`}* +
+**Example:** `Music` + +--- +##### `music_analysis_version` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `parent_guid` *{`Optional[str]`}* +
+**Example:** `plex://album/65394d6d472b8ab03ef47f12` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/67084` + +--- +##### `parent_rating_key` *{`Optional[str]`}* +
+**Example:** `67084` + +--- +##### `parent_studio` *{`Optional[str]`}* +
+**Example:** `Reprise Records` + +--- +##### `parent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `parent_title` *{`Optional[str]`}* +
+**Example:** `Saviors` + +--- +##### `parent_year` *{`Optional[int]`}* +
+**Example:** `2024` + +--- +##### `rating_count` *{`Optional[int]`}* +
+**Example:** `45885` + +--- +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `67085` + +--- +##### `session_key` *{`Optional[str]`}* +
+**Example:** `203` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `The American Dream Is Killing Me` + +--- +##### `title_sort` *{`Optional[str]`}* +
+**Example:** `American Dream Is Killing Me` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `track` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705543314` + +--- +##### `view_offset` *{`Optional[int]`}* +
+**Example:** `1000` + +--- +##### `media` *{`List[operations.GetSessionsMedia]`}* +
+**Example:** `[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}]` + + import('/content/types/models/operations/get_sessions_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `user` *{`Optional[operations.User]`}* + + import('/content/types/models/operations/user/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `player` *{`Optional[operations.Player]`}* + + import('/content/types/models/operations/player/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `session` *{`Optional[operations.Session]`}* + + import('/content/types/models/operations/session/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_metadata/typescript.mdx b/content/types/models/operations/get_sessions_metadata/typescript.mdx new file mode 100644 index 0000000..29fe069 --- /dev/null +++ b/content/types/models/operations/get_sessions_metadata/typescript.mdx @@ -0,0 +1,195 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `addedAt?`: *{`number`}* +
+**Example:** `1705543312` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `186240` + +--- +##### `grandparentArt?`: *{`string`}* +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `grandparentGuid?`: *{`string`}* +
+**Example:** `plex://artist/5d07bbfd403c6402904a6480` + +--- +##### `grandparentKey?`: *{`string`}* +
+**Example:** `/library/metadata/39904` + +--- +##### `grandparentRatingKey?`: *{`string`}* +
+**Example:** `39904` + +--- +##### `grandparentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/39904/thumb/1705310687` + +--- +##### `grandparentTitle?`: *{`string`}* +
+**Example:** `Green Day` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://track/6535834f71f22f36f71a8e8f` + +--- +##### `index?`: *{`number`}* +
+**Example:** `1` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/67085` + +--- +##### `librarySectionID?`: *{`string`}* +
+**Example:** `3` + +--- +##### `librarySectionKey?`: *{`string`}* +
+**Example:** `/library/sections/3` + +--- +##### `librarySectionTitle?`: *{`string`}* +
+**Example:** `Music` + +--- +##### `musicAnalysisVersion?`: *{`string`}* +
+**Example:** `1` + +--- +##### `parentGuid?`: *{`string`}* +
+**Example:** `plex://album/65394d6d472b8ab03ef47f12` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentKey?`: *{`string`}* +
+**Example:** `/library/metadata/67084` + +--- +##### `parentRatingKey?`: *{`string`}* +
+**Example:** `67084` + +--- +##### `parentStudio?`: *{`string`}* +
+**Example:** `Reprise Records` + +--- +##### `parentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `parentTitle?`: *{`string`}* +
+**Example:** `Saviors` + +--- +##### `parentYear?`: *{`number`}* +
+**Example:** `2024` + +--- +##### `ratingCount?`: *{`number`}* +
+**Example:** `45885` + +--- +##### `ratingKey?`: *{`string`}* +
+**Example:** `67085` + +--- +##### `sessionKey?`: *{`string`}* +
+**Example:** `203` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `title?`: *{`string`}* +
+**Example:** `The American Dream Is Killing Me` + +--- +##### `titleSort?`: *{`string`}* +
+**Example:** `American Dream Is Killing Me` + +--- +##### `type?`: *{`string`}* +
+**Example:** `track` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705543314` + +--- +##### `viewOffset?`: *{`number`}* +
+**Example:** `1000` + +--- +##### `media?`: *{`operations.GetSessionsMedia[]`}* +
+**Example:** `[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}]` + + import('/content/types/models/operations/get_sessions_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `user?`: *{`operations.User`}* + + import('/content/types/models/operations/user/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `player?`: *{`operations.Player`}* + + import('/content/types/models/operations/player/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `session?`: *{`operations.Session`}* + + import('/content/types/models/operations/session/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_part/go.mdx b/content/types/models/operations/get_sessions_part/go.mdx new file mode 100644 index 0000000..1117b85 --- /dev/null +++ b/content/types/models/operations/get_sessions_part/go.mdx @@ -0,0 +1,57 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Container` *{`*string`}* +
+**Example:** `flac` + +--- +##### `Duration` *{`*int`}* +
+**Example:** `186240` + +--- +##### `File` *{`*string`}* +
+**Example:** `/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac` + +--- +##### `HasThumbnail` *{`*string`}* +
+**Example:** `1` + +--- +##### `ID` *{`*string`}* +
+**Example:** `130625` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/parts/130625/1705543268/file.flac` + +--- +##### `Size` *{`*int`}* +
+**Example:** `23644000` + +--- +##### `Decision` *{`*string`}* +
+**Example:** `directplay` + +--- +##### `Selected` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Stream` *{`[]operations.GetSessionsStream`}* +
+**Example:** `[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}]` + + import('/content/types/models/operations/get_sessions_stream/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_part/python.mdx b/content/types/models/operations/get_sessions_part/python.mdx new file mode 100644 index 0000000..c96a751 --- /dev/null +++ b/content/types/models/operations/get_sessions_part/python.mdx @@ -0,0 +1,57 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `container` *{`Optional[str]`}* +
+**Example:** `flac` + +--- +##### `duration` *{`Optional[int]`}* +
+**Example:** `186240` + +--- +##### `file` *{`Optional[str]`}* +
+**Example:** `/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac` + +--- +##### `has_thumbnail` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `id` *{`Optional[str]`}* +
+**Example:** `130625` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/parts/130625/1705543268/file.flac` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `23644000` + +--- +##### `decision` *{`Optional[str]`}* +
+**Example:** `directplay` + +--- +##### `selected` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `stream` *{`List[operations.GetSessionsStream]`}* +
+**Example:** `[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}]` + + import('/content/types/models/operations/get_sessions_stream/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_part/typescript.mdx b/content/types/models/operations/get_sessions_part/typescript.mdx new file mode 100644 index 0000000..aa7c562 --- /dev/null +++ b/content/types/models/operations/get_sessions_part/typescript.mdx @@ -0,0 +1,57 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `container?`: *{`string`}* +
+**Example:** `flac` + +--- +##### `duration?`: *{`number`}* +
+**Example:** `186240` + +--- +##### `file?`: *{`string`}* +
+**Example:** `/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac` + +--- +##### `hasThumbnail?`: *{`string`}* +
+**Example:** `1` + +--- +##### `id?`: *{`string`}* +
+**Example:** `130625` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/parts/130625/1705543268/file.flac` + +--- +##### `size?`: *{`number`}* +
+**Example:** `23644000` + +--- +##### `decision?`: *{`string`}* +
+**Example:** `directplay` + +--- +##### `selected?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `stream?`: *{`operations.GetSessionsStream[]`}* +
+**Example:** `[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}]` + + import('/content/types/models/operations/get_sessions_stream/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_response/go.mdx b/content/types/models/operations/get_sessions_response/go.mdx index 3b4ae5c..d816efb 100644 --- a/content/types/models/operations/get_sessions_response/go.mdx +++ b/content/types/models/operations/get_sessions_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetSessionsResponseBody`}* +List of Active Plex Sessions + + import('/content/types/models/operations/get_sessions_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_sessions_response/python.mdx b/content/types/models/operations/get_sessions_response/python.mdx index 93ee0a0..e8ed842 100644 --- a/content/types/models/operations/get_sessions_response/python.mdx +++ b/content/types/models/operations/get_sessions_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetSessionsResponseBody]`}* +List of Active Plex Sessions + + import('/content/types/models/operations/get_sessions_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_sessions_response/typescript.mdx b/content/types/models/operations/get_sessions_response/typescript.mdx index 2035a36..fef0e2b 100644 --- a/content/types/models/operations/get_sessions_response/typescript.mdx +++ b/content/types/models/operations/get_sessions_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetSessionsResponseBody`}* +List of Active Plex Sessions + + import('/content/types/models/operations/get_sessions_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_sessions_response_body/go.mdx b/content/types/models/operations/get_sessions_response_body/go.mdx new file mode 100644 index 0000000..c1e07c4 --- /dev/null +++ b/content/types/models/operations/get_sessions_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetSessionsMediaContainer`}* + + import('/content/types/models/operations/get_sessions_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_response_body/python.mdx b/content/types/models/operations/get_sessions_response_body/python.mdx new file mode 100644 index 0000000..bf39739 --- /dev/null +++ b/content/types/models/operations/get_sessions_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetSessionsMediaContainer]`}* + + import('/content/types/models/operations/get_sessions_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_response_body/typescript.mdx b/content/types/models/operations/get_sessions_response_body/typescript.mdx new file mode 100644 index 0000000..b707623 --- /dev/null +++ b/content/types/models/operations/get_sessions_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetSessionsMediaContainer`}* + + import('/content/types/models/operations/get_sessions_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_sessions_stream/go.mdx b/content/types/models/operations/get_sessions_stream/go.mdx new file mode 100644 index 0000000..d00656e --- /dev/null +++ b/content/types/models/operations/get_sessions_stream/go.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `AlbumGain` *{`*string`}* +
+**Example:** `-12.94` + +--- +##### `AlbumPeak` *{`*string`}* +
+**Example:** `1.000000` + +--- +##### `AlbumRange` *{`*string`}* +
+**Example:** `4.751014` + +--- +##### `AudioChannelLayout` *{`*string`}* +
+**Example:** `stereo` + +--- +##### `BitDepth` *{`*int`}* +
+**Example:** `16` + +--- +##### `Bitrate` *{`*int`}* +
+**Example:** `1014` + +--- +##### `Channels` *{`*int`}* +
+**Example:** `2` + +--- +##### `Codec` *{`*string`}* +
+**Example:** `flac` + +--- +##### `DisplayTitle` *{`*string`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `ExtendedDisplayTitle` *{`*string`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `Gain` *{`*string`}* +
+**Example:** `-12.94` + +--- +##### `ID` *{`*string`}* +
+**Example:** `352487` + +--- +##### `Index` *{`*int`}* +
+**Example:** `0` + +--- +##### `Loudness` *{`*string`}* +
+**Example:** `-5.94` + +--- +##### `Lra` *{`*string`}* +
+**Example:** `1.74` + +--- +##### `Peak` *{`*string`}* +
+**Example:** `1.000000` + +--- +##### `SamplingRate` *{`*int`}* +
+**Example:** `44100` + +--- +##### `Selected` *{`*bool`}* +
+**Example:** `true` + +--- +##### `StreamType` *{`*int`}* +
+**Example:** `2` + +--- +##### `Location` *{`*string`}* +
+**Example:** `direct` + + diff --git a/content/types/models/operations/get_sessions_stream/python.mdx b/content/types/models/operations/get_sessions_stream/python.mdx new file mode 100644 index 0000000..b74b304 --- /dev/null +++ b/content/types/models/operations/get_sessions_stream/python.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `album_gain` *{`Optional[str]`}* +
+**Example:** `-12.94` + +--- +##### `album_peak` *{`Optional[str]`}* +
+**Example:** `1.000000` + +--- +##### `album_range` *{`Optional[str]`}* +
+**Example:** `4.751014` + +--- +##### `audio_channel_layout` *{`Optional[str]`}* +
+**Example:** `stereo` + +--- +##### `bit_depth` *{`Optional[int]`}* +
+**Example:** `16` + +--- +##### `bitrate` *{`Optional[int]`}* +
+**Example:** `1014` + +--- +##### `channels` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `codec` *{`Optional[str]`}* +
+**Example:** `flac` + +--- +##### `display_title` *{`Optional[str]`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `extended_display_title` *{`Optional[str]`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `gain` *{`Optional[str]`}* +
+**Example:** `-12.94` + +--- +##### `id` *{`Optional[str]`}* +
+**Example:** `352487` + +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `0` + +--- +##### `loudness` *{`Optional[str]`}* +
+**Example:** `-5.94` + +--- +##### `lra` *{`Optional[str]`}* +
+**Example:** `1.74` + +--- +##### `peak` *{`Optional[str]`}* +
+**Example:** `1.000000` + +--- +##### `sampling_rate` *{`Optional[int]`}* +
+**Example:** `44100` + +--- +##### `selected` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `stream_type` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `location` *{`Optional[str]`}* +
+**Example:** `direct` + + diff --git a/content/types/models/operations/get_sessions_stream/typescript.mdx b/content/types/models/operations/get_sessions_stream/typescript.mdx new file mode 100644 index 0000000..accce93 --- /dev/null +++ b/content/types/models/operations/get_sessions_stream/typescript.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `albumGain?`: *{`string`}* +
+**Example:** `-12.94` + +--- +##### `albumPeak?`: *{`string`}* +
+**Example:** `1.000000` + +--- +##### `albumRange?`: *{`string`}* +
+**Example:** `4.751014` + +--- +##### `audioChannelLayout?`: *{`string`}* +
+**Example:** `stereo` + +--- +##### `bitDepth?`: *{`number`}* +
+**Example:** `16` + +--- +##### `bitrate?`: *{`number`}* +
+**Example:** `1014` + +--- +##### `channels?`: *{`number`}* +
+**Example:** `2` + +--- +##### `codec?`: *{`string`}* +
+**Example:** `flac` + +--- +##### `displayTitle?`: *{`string`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `extendedDisplayTitle?`: *{`string`}* +
+**Example:** `FLAC (Stereo)` + +--- +##### `gain?`: *{`string`}* +
+**Example:** `-12.94` + +--- +##### `id?`: *{`string`}* +
+**Example:** `352487` + +--- +##### `index?`: *{`number`}* +
+**Example:** `0` + +--- +##### `loudness?`: *{`string`}* +
+**Example:** `-5.94` + +--- +##### `lra?`: *{`string`}* +
+**Example:** `1.74` + +--- +##### `peak?`: *{`string`}* +
+**Example:** `1.000000` + +--- +##### `samplingRate?`: *{`number`}* +
+**Example:** `44100` + +--- +##### `selected?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `streamType?`: *{`number`}* +
+**Example:** `2` + +--- +##### `location?`: *{`string`}* +
+**Example:** `direct` + + diff --git a/content/types/models/operations/get_transcode_sessions_media_container/go.mdx b/content/types/models/operations/get_transcode_sessions_media_container/go.mdx index 1519ff9..d3a5511 100644 --- a/content/types/models/operations/get_transcode_sessions_media_container/go.mdx +++ b/content/types/models/operations/get_transcode_sessions_media_container/go.mdx @@ -2,12 +2,14 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `Size` *{`*float64`}* +##### `Size` *{`*int`}*
**Example:** `1` --- ##### `TranscodeSession` *{`[]operations.TranscodeSession`}* +
+**Example:** `[{"audioChannels":1,"audioCodec":"opus","audioDecision":"transcode","complete":false,"container":"mkv","context":"streaming","duration":1445695,"error":false,"key":"vv3i2q2lax92qlzul1hbd4bx","maxOffsetAvailable":29.53,"minOffsetAvailable":3.003000020980835,"progress":1.7999999523162842,"protocol":"http","remaining":53,"size":-22,"sourceAudioCodec":"aac","sourceVideoCodec":"h264","speed":25.100000381469727,"subtitleDecision":"burn","throttled":false,"timeStamp":1705895805.4919229,"transcodeHwRequested":true,"videoCodec":"h264","videoDecision":"transcode"}]` import('/content/types/models/operations/transcode_session/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_transcode_sessions_media_container/python.mdx b/content/types/models/operations/get_transcode_sessions_media_container/python.mdx index fb9a676..f1abd2b 100644 --- a/content/types/models/operations/get_transcode_sessions_media_container/python.mdx +++ b/content/types/models/operations/get_transcode_sessions_media_container/python.mdx @@ -2,12 +2,14 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `size` *{`Optional[float]`}* +##### `size` *{`Optional[int]`}*
**Example:** `1` --- ##### `transcode_session` *{`List[operations.TranscodeSession]`}* +
+**Example:** `[{"audioChannels":1,"audioCodec":"opus","audioDecision":"transcode","complete":false,"container":"mkv","context":"streaming","duration":1445695,"error":false,"key":"vv3i2q2lax92qlzul1hbd4bx","maxOffsetAvailable":29.53,"minOffsetAvailable":3.003000020980835,"progress":1.7999999523162842,"protocol":"http","remaining":53,"size":-22,"sourceAudioCodec":"aac","sourceVideoCodec":"h264","speed":25.100000381469727,"subtitleDecision":"burn","throttled":false,"timeStamp":1705895805.4919229,"transcodeHwRequested":true,"videoCodec":"h264","videoDecision":"transcode"}]` import('/content/types/models/operations/transcode_session/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx b/content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx index 9a1289b..5009487 100644 --- a/content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx +++ b/content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx @@ -8,6 +8,8 @@ import Labels from "/src/lib/labels"; --- ##### `transcodeSession?`: *{`operations.TranscodeSession[]`}* +
+**Example:** `[{"audioChannels":1,"audioCodec":"opus","audioDecision":"transcode","complete":false,"container":"mkv","context":"streaming","duration":1445695,"error":false,"key":"vv3i2q2lax92qlzul1hbd4bx","maxOffsetAvailable":29.53,"minOffsetAvailable":3.003000020980835,"progress":1.7999999523162842,"protocol":"http","remaining":53,"size":-22,"sourceAudioCodec":"aac","sourceVideoCodec":"h264","speed":25.100000381469727,"subtitleDecision":"burn","throttled":false,"timeStamp":1705895805.4919229,"transcodeHwRequested":true,"videoCodec":"h264","videoDecision":"transcode"}]` import('/content/types/models/operations/transcode_session/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_update_status_media_container/go.mdx b/content/types/models/operations/get_update_status_media_container/go.mdx new file mode 100644 index 0000000..40078cb --- /dev/null +++ b/content/types/models/operations/get_update_status_media_container/go.mdx @@ -0,0 +1,37 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `1` + +--- +##### `CanInstall` *{`*bool`}* +
+**Example:** `false` + +--- +##### `CheckedAt` *{`*int`}* +
+**Example:** `1705801232` + +--- +##### `DownloadURL` *{`*string`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `Status` *{`*int`}* +
+**Example:** `0` + +--- +##### `Release` *{`[]operations.Release`}* +
+**Example:** `[{"added":"(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0","downloadURL":"https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx","fixed":"(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)","key":"https://plex.tv/updater/releases/5136","state":"notify","version":"1.40.0.7775-456fbaf97"}]` + + import('/content/types/models/operations/release/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_update_status_media_container/python.mdx b/content/types/models/operations/get_update_status_media_container/python.mdx new file mode 100644 index 0000000..3836ecf --- /dev/null +++ b/content/types/models/operations/get_update_status_media_container/python.mdx @@ -0,0 +1,37 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `can_install` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `checked_at` *{`Optional[int]`}* +
+**Example:** `1705801232` + +--- +##### `download_url` *{`Optional[str]`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `status` *{`Optional[int]`}* +
+**Example:** `0` + +--- +##### `release` *{`List[operations.Release]`}* +
+**Example:** `[{"added":"(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0","downloadURL":"https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx","fixed":"(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)","key":"https://plex.tv/updater/releases/5136","state":"notify","version":"1.40.0.7775-456fbaf97"}]` + + import('/content/types/models/operations/release/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_update_status_media_container/typescript.mdx b/content/types/models/operations/get_update_status_media_container/typescript.mdx new file mode 100644 index 0000000..8f428eb --- /dev/null +++ b/content/types/models/operations/get_update_status_media_container/typescript.mdx @@ -0,0 +1,37 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `1` + +--- +##### `canInstall?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `checkedAt?`: *{`number`}* +
+**Example:** `1705801232` + +--- +##### `downloadURL?`: *{`string`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `status?`: *{`number`}* +
+**Example:** `0` + +--- +##### `release?`: *{`operations.Release[]`}* +
+**Example:** `[{"added":"(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0","downloadURL":"https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx","fixed":"(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)","key":"https://plex.tv/updater/releases/5136","state":"notify","version":"1.40.0.7775-456fbaf97"}]` + + import('/content/types/models/operations/release/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_update_status_response/go.mdx b/content/types/models/operations/get_update_status_response/go.mdx index 3b4ae5c..6c9d54f 100644 --- a/content/types/models/operations/get_update_status_response/go.mdx +++ b/content/types/models/operations/get_update_status_response/go.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ContentType` *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) Raw HTTP response; suitable for custom response parsing +--- +##### `Object` *{`*operations.GetUpdateStatusResponseBody`}* +The Server Updates + + import('/content/types/models/operations/get_update_status_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_update_status_response/python.mdx b/content/types/models/operations/get_update_status_response/python.mdx index 93ee0a0..ef8b292 100644 --- a/content/types/models/operations/get_update_status_response/python.mdx +++ b/content/types/models/operations/get_update_status_response/python.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `content_type` *{`str`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object` *{`Optional[operations.GetUpdateStatusResponseBody]`}* +The Server Updates + + import('/content/types/models/operations/get_update_status_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_update_status_response/typescript.mdx b/content/types/models/operations/get_update_status_response/typescript.mdx index 2035a36..6d4c0dd 100644 --- a/content/types/models/operations/get_update_status_response/typescript.mdx +++ b/content/types/models/operations/get_update_status_response/typescript.mdx @@ -1,4 +1,7 @@ {/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `contentType`: *{`string`}* HTTP response content type for this operation @@ -10,4 +13,11 @@ HTTP response status code for this operation ##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) Raw HTTP response; suitable for custom response parsing +--- +##### `object?`: *{`operations.GetUpdateStatusResponseBody`}* +The Server Updates + + import('/content/types/models/operations/get_update_status_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/models/operations/get_update_status_response_body/go.mdx b/content/types/models/operations/get_update_status_response_body/go.mdx new file mode 100644 index 0000000..330a856 --- /dev/null +++ b/content/types/models/operations/get_update_status_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.GetUpdateStatusMediaContainer`}* + + import('/content/types/models/operations/get_update_status_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_update_status_response_body/python.mdx b/content/types/models/operations/get_update_status_response_body/python.mdx new file mode 100644 index 0000000..4733f4a --- /dev/null +++ b/content/types/models/operations/get_update_status_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.GetUpdateStatusMediaContainer]`}* + + import('/content/types/models/operations/get_update_status_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_update_status_response_body/typescript.mdx b/content/types/models/operations/get_update_status_response_body/typescript.mdx new file mode 100644 index 0000000..4b82e52 --- /dev/null +++ b/content/types/models/operations/get_update_status_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.GetUpdateStatusMediaContainer`}* + + import('/content/types/models/operations/get_update_status_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/guids/go.mdx b/content/types/models/operations/guids/go.mdx index 50de91e..018bac2 100644 --- a/content/types/models/operations/guids/go.mdx +++ b/content/types/models/operations/guids/go.mdx @@ -1,6 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `ID` *{`*string`}*
-**Example:** `imdb://tt13303712` +**Example:** `tvdb://2337` diff --git a/content/types/models/operations/guids/python.mdx b/content/types/models/operations/guids/python.mdx index 731e74c..95acaa9 100644 --- a/content/types/models/operations/guids/python.mdx +++ b/content/types/models/operations/guids/python.mdx @@ -1,6 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `id` *{`Optional[str]`}*
-**Example:** `imdb://tt13303712` +**Example:** `tvdb://2337` diff --git a/content/types/models/operations/guids/typescript.mdx b/content/types/models/operations/guids/typescript.mdx index 858506b..8ad3674 100644 --- a/content/types/models/operations/guids/typescript.mdx +++ b/content/types/models/operations/guids/typescript.mdx @@ -1,6 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `id?`: *{`string`}*
-**Example:** `imdb://tt13303712` +**Example:** `tvdb://2337` diff --git a/content/types/models/operations/hub/go.mdx b/content/types/models/operations/hub/go.mdx new file mode 100644 index 0000000..c952cb3 --- /dev/null +++ b/content/types/models/operations/hub/go.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `HubKey` *{`*string`}* +
+**Example:** `/library/metadata/50768,65523,58188,57341,57302,57070` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Recent Playlists` + +--- +##### `Type` *{`*string`}* +
+**Example:** `playlist` + +--- +##### `HubIdentifier` *{`*string`}* +
+**Example:** `home.playlists` + +--- +##### `Context` *{`*string`}* +
+**Example:** `hub.home.playlists` + +--- +##### `Size` *{`*int`}* +
+**Example:** `6` + +--- +##### `More` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Style` *{`*string`}* +
+**Example:** `shelf` + +--- +##### `Promoted` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Metadata` *{`[]operations.GetGlobalHubsMetadata`}* +
+**Example:** `[{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","icon":"playlist://image.smart","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","titleSort":"Tracks","type":"playlist","updatedAt":1668787730,"viewCount":2}]` + + import('/content/types/models/operations/get_global_hubs_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/hub/python.mdx b/content/types/models/operations/hub/python.mdx new file mode 100644 index 0000000..dc5bd7d --- /dev/null +++ b/content/types/models/operations/hub/python.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `hub_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/50768,65523,58188,57341,57302,57070` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Recent Playlists` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `playlist` + +--- +##### `hub_identifier` *{`Optional[str]`}* +
+**Example:** `home.playlists` + +--- +##### `context` *{`Optional[str]`}* +
+**Example:** `hub.home.playlists` + +--- +##### `size` *{`Optional[int]`}* +
+**Example:** `6` + +--- +##### `more` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `style` *{`Optional[str]`}* +
+**Example:** `shelf` + +--- +##### `promoted` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `metadata` *{`List[operations.GetGlobalHubsMetadata]`}* +
+**Example:** `[{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","icon":"playlist://image.smart","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","titleSort":"Tracks","type":"playlist","updatedAt":1668787730,"viewCount":2}]` + + import('/content/types/models/operations/get_global_hubs_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/hub/typescript.mdx b/content/types/models/operations/hub/typescript.mdx new file mode 100644 index 0000000..6cd50e0 --- /dev/null +++ b/content/types/models/operations/hub/typescript.mdx @@ -0,0 +1,62 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `hubKey?`: *{`string`}* +
+**Example:** `/library/metadata/50768,65523,58188,57341,57302,57070` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Recent Playlists` + +--- +##### `type?`: *{`string`}* +
+**Example:** `playlist` + +--- +##### `hubIdentifier?`: *{`string`}* +
+**Example:** `home.playlists` + +--- +##### `context?`: *{`string`}* +
+**Example:** `hub.home.playlists` + +--- +##### `size?`: *{`number`}* +
+**Example:** `6` + +--- +##### `more?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `style?`: *{`string`}* +
+**Example:** `shelf` + +--- +##### `promoted?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `metadata?`: *{`operations.GetGlobalHubsMetadata[]`}* +
+**Example:** `[{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","icon":"playlist://image.smart","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","titleSort":"Tracks","type":"playlist","updatedAt":1668787730,"viewCount":2}]` + + import('/content/types/models/operations/get_global_hubs_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/log_line_request/go.mdx b/content/types/models/operations/log_line_request/go.mdx index fddeb9c..a62c64b 100644 --- a/content/types/models/operations/log_line_request/go.mdx +++ b/content/types/models/operations/log_line_request/go.mdx @@ -6,7 +6,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -17,9 +17,13 @@ An integer log level to write to the PMS log with. --- ##### `Message` *{`string`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `Source` *{`string`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/types/models/operations/log_line_request/python.mdx b/content/types/models/operations/log_line_request/python.mdx index 608184b..ec38928 100644 --- a/content/types/models/operations/log_line_request/python.mdx +++ b/content/types/models/operations/log_line_request/python.mdx @@ -6,7 +6,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -17,9 +17,13 @@ An integer log level to write to the PMS log with. --- ##### `message` *{`str`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` *{`str`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/types/models/operations/log_line_request/typescript.mdx b/content/types/models/operations/log_line_request/typescript.mdx index 351778c..07b9a07 100644 --- a/content/types/models/operations/log_line_request/typescript.mdx +++ b/content/types/models/operations/log_line_request/typescript.mdx @@ -6,7 +6,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -17,9 +17,13 @@ An integer log level to write to the PMS log with. --- ##### `message`: *{`string`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source`: *{`string`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/types/models/operations/one/go.mdx b/content/types/models/operations/one/go.mdx new file mode 100644 index 0000000..e9cf5c0 --- /dev/null +++ b/content/types/models/operations/one/go.mdx @@ -0,0 +1,44 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*string`}* +
+**Example:** `FriendlyName` + +--- +##### `Label` *{`*string`}* +
+**Example:** `Friendly name` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `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` *{`*string`}* +
+**Example:** `text` + +--- +##### `Default` *{`*string`}* + +--- +##### `Value` *{`*string`}* +
+**Example:** `Hera` + +--- +##### `Hidden` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Advanced` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Group` *{`*string`}* +
+**Example:** `general` + + diff --git a/content/types/models/operations/one/python.mdx b/content/types/models/operations/one/python.mdx new file mode 100644 index 0000000..51886df --- /dev/null +++ b/content/types/models/operations/one/python.mdx @@ -0,0 +1,44 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[str]`}* +
+**Example:** `FriendlyName` + +--- +##### `label` *{`Optional[str]`}* +
+**Example:** `Friendly name` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `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]`}* +
+**Example:** `text` + +--- +##### `default` *{`Optional[str]`}* + +--- +##### `value` *{`Optional[str]`}* +
+**Example:** `Hera` + +--- +##### `hidden` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `advanced` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `group` *{`Optional[str]`}* +
+**Example:** `general` + + diff --git a/content/types/models/operations/one/typescript.mdx b/content/types/models/operations/one/typescript.mdx new file mode 100644 index 0000000..493aa83 --- /dev/null +++ b/content/types/models/operations/one/typescript.mdx @@ -0,0 +1,44 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`string`}* +
+**Example:** `FriendlyName` + +--- +##### `label?`: *{`string`}* +
+**Example:** `Friendly name` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `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?`: *{`string`}* +
+**Example:** `text` + +--- +##### `default?`: *{`string`}* + +--- +##### `value?`: *{`string`}* +
+**Example:** `Hera` + +--- +##### `hidden?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `advanced?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `group?`: *{`string`}* +
+**Example:** `general` + + diff --git a/content/types/models/operations/operator/go.mdx b/content/types/models/operations/operator/go.mdx new file mode 100644 index 0000000..a5877fb --- /dev/null +++ b/content/types/models/operations/operator/go.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Key` *{`*string`}* +
+**Example:** `=` + +--- +##### `Title` *{`*string`}* +
+**Example:** `is` + + diff --git a/content/types/models/operations/operator/python.mdx b/content/types/models/operations/operator/python.mdx new file mode 100644 index 0000000..6cdf5d4 --- /dev/null +++ b/content/types/models/operations/operator/python.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` *{`Optional[str]`}* +
+**Example:** `=` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `is` + + diff --git a/content/types/models/operations/operator/typescript.mdx b/content/types/models/operations/operator/typescript.mdx new file mode 100644 index 0000000..34b148d --- /dev/null +++ b/content/types/models/operations/operator/typescript.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key?`: *{`string`}* +
+**Example:** `=` + +--- +##### `title?`: *{`string`}* +
+**Example:** `is` + + diff --git a/content/types/models/operations/player/go.mdx b/content/types/models/operations/player/go.mdx new file mode 100644 index 0000000..ad66c57 --- /dev/null +++ b/content/types/models/operations/player/go.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Address` *{`*string`}* +
+**Example:** `10.10.10.171` + +--- +##### `MachineIdentifier` *{`*string`}* +
+**Example:** `3tsdzir85m2onc3qyr255aq1` + +--- +##### `Model` *{`*string`}* +
+**Example:** `standalone` + +--- +##### `Platform` *{`*string`}* +
+**Example:** `windows` + +--- +##### `PlatformVersion` *{`*string`}* +
+**Example:** `10.0.22621` + +--- +##### `Product` *{`*string`}* +
+**Example:** `Plex for Windows` + +--- +##### `Profile` *{`*string`}* +
+**Example:** `Plex Desktop` + +--- +##### `RemotePublicAddress` *{`*string`}* +
+**Example:** `68.248.140.20` + +--- +##### `State` *{`*string`}* +
+**Example:** `playing` + +--- +##### `Title` *{`*string`}* +
+**Example:** `DESKTOP-BL80MTD` + +--- +##### `Version` *{`*string`}* +
+**Example:** `1.85.0.4071-21128b56` + +--- +##### `Local` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Relayed` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Secure` *{`*bool`}* +
+**Example:** `true` + +--- +##### `UserID` *{`*int`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/player/python.mdx b/content/types/models/operations/player/python.mdx new file mode 100644 index 0000000..c53f818 --- /dev/null +++ b/content/types/models/operations/player/python.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `address` *{`Optional[str]`}* +
+**Example:** `10.10.10.171` + +--- +##### `machine_identifier` *{`Optional[str]`}* +
+**Example:** `3tsdzir85m2onc3qyr255aq1` + +--- +##### `model` *{`Optional[str]`}* +
+**Example:** `standalone` + +--- +##### `platform` *{`Optional[str]`}* +
+**Example:** `windows` + +--- +##### `platform_version` *{`Optional[str]`}* +
+**Example:** `10.0.22621` + +--- +##### `product` *{`Optional[str]`}* +
+**Example:** `Plex for Windows` + +--- +##### `profile` *{`Optional[str]`}* +
+**Example:** `Plex Desktop` + +--- +##### `remote_public_address` *{`Optional[str]`}* +
+**Example:** `68.248.140.20` + +--- +##### `state` *{`Optional[str]`}* +
+**Example:** `playing` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `DESKTOP-BL80MTD` + +--- +##### `version` *{`Optional[str]`}* +
+**Example:** `1.85.0.4071-21128b56` + +--- +##### `local` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `relayed` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `secure` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `user_id` *{`Optional[int]`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/player/typescript.mdx b/content/types/models/operations/player/typescript.mdx new file mode 100644 index 0000000..91bf3f7 --- /dev/null +++ b/content/types/models/operations/player/typescript.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `address?`: *{`string`}* +
+**Example:** `10.10.10.171` + +--- +##### `machineIdentifier?`: *{`string`}* +
+**Example:** `3tsdzir85m2onc3qyr255aq1` + +--- +##### `model?`: *{`string`}* +
+**Example:** `standalone` + +--- +##### `platform?`: *{`string`}* +
+**Example:** `windows` + +--- +##### `platformVersion?`: *{`string`}* +
+**Example:** `10.0.22621` + +--- +##### `product?`: *{`string`}* +
+**Example:** `Plex for Windows` + +--- +##### `profile?`: *{`string`}* +
+**Example:** `Plex Desktop` + +--- +##### `remotePublicAddress?`: *{`string`}* +
+**Example:** `68.248.140.20` + +--- +##### `state?`: *{`string`}* +
+**Example:** `playing` + +--- +##### `title?`: *{`string`}* +
+**Example:** `DESKTOP-BL80MTD` + +--- +##### `version?`: *{`string`}* +
+**Example:** `1.85.0.4071-21128b56` + +--- +##### `local?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `relayed?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `secure?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `userID?`: *{`number`}* +
+**Example:** `1` + + diff --git a/content/types/models/operations/producer/go.mdx b/content/types/models/operations/producer/go.mdx new file mode 100644 index 0000000..0486113 --- /dev/null +++ b/content/types/models/operations/producer/go.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*int`}* +
+**Example:** `221` + +--- +##### `Filter` *{`*string`}* +
+**Example:** `producer=221` + +--- +##### `Tag` *{`*string`}* +
+**Example:** `Barry Mendel` + +--- +##### `TagKey` *{`*string`}* +
+**Example:** `5d776826961905001eb90e2b` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg` + + diff --git a/content/types/models/operations/producer/python.mdx b/content/types/models/operations/producer/python.mdx new file mode 100644 index 0000000..50344f8 --- /dev/null +++ b/content/types/models/operations/producer/python.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[int]`}* +
+**Example:** `221` + +--- +##### `filter_` *{`Optional[str]`}* +
+**Example:** `producer=221` + +--- +##### `tag` *{`Optional[str]`}* +
+**Example:** `Barry Mendel` + +--- +##### `tag_key` *{`Optional[str]`}* +
+**Example:** `5d776826961905001eb90e2b` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg` + + diff --git a/content/types/models/operations/producer/typescript.mdx b/content/types/models/operations/producer/typescript.mdx new file mode 100644 index 0000000..543c4db --- /dev/null +++ b/content/types/models/operations/producer/typescript.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`number`}* +
+**Example:** `221` + +--- +##### `filter?`: *{`string`}* +
+**Example:** `producer=221` + +--- +##### `tag?`: *{`string`}* +
+**Example:** `Barry Mendel` + +--- +##### `tagKey?`: *{`string`}* +
+**Example:** `5d776826961905001eb90e2b` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg` + + diff --git a/content/types/models/operations/ratings/go.mdx b/content/types/models/operations/ratings/go.mdx new file mode 100644 index 0000000..b31e133 --- /dev/null +++ b/content/types/models/operations/ratings/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Image` *{`*string`}* +
+**Example:** `themoviedb://image.rating` + +--- +##### `Value` *{`*float64`}* +
+**Example:** `7.4` + +--- +##### `Type` *{`*string`}* +
+**Example:** `audience` + + diff --git a/content/types/models/operations/ratings/python.mdx b/content/types/models/operations/ratings/python.mdx new file mode 100644 index 0000000..2f5afc0 --- /dev/null +++ b/content/types/models/operations/ratings/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `image` *{`Optional[str]`}* +
+**Example:** `themoviedb://image.rating` + +--- +##### `value` *{`Optional[float]`}* +
+**Example:** `7.4` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `audience` + + diff --git a/content/types/models/operations/ratings/typescript.mdx b/content/types/models/operations/ratings/typescript.mdx new file mode 100644 index 0000000..042d1f9 --- /dev/null +++ b/content/types/models/operations/ratings/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `image?`: *{`string`}* +
+**Example:** `themoviedb://image.rating` + +--- +##### `value?`: *{`number`}* +
+**Example:** `7.4` + +--- +##### `type?`: *{`string`}* +
+**Example:** `audience` + + diff --git a/content/types/models/operations/release/go.mdx b/content/types/models/operations/release/go.mdx new file mode 100644 index 0000000..1147166 --- /dev/null +++ b/content/types/models/operations/release/go.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Key` *{`*string`}* +
+**Example:** `https://plex.tv/updater/releases/5136` + +--- +##### `Version` *{`*string`}* +
+**Example:** `1.40.0.7775-456fbaf97` + +--- +##### `Added` *{`*string`}* +
+**Example:** `(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish. +(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793) +(Music) Store track genres and add filtering options (#14653) +(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653) +(View History) No longer create a view history entry for items marked as played (#10888) +(Web) Updated to 4.118.0` + +--- +##### `Fixed` *{`*string`}* +
+**Example:** `(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483) +(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654) +(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667) +(Collection) Server could become unresponsive when collection membership changes (#14612) +(DVR) Previously watched recordings could be deleted without being watched again (#13779) +(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501) +(Library) The Content Rating not equal to None filter does not work (#14620) +(Search) Album search results could contain all the album's tracks too (#14486) +(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674) +(Transcoder) HW encoding would fail on devices with no rate control (#14222) +(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)` + +--- +##### `DownloadURL` *{`*string`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `State` *{`*string`}* +
+**Example:** `notify` + + diff --git a/content/types/models/operations/release/python.mdx b/content/types/models/operations/release/python.mdx new file mode 100644 index 0000000..4bdf225 --- /dev/null +++ b/content/types/models/operations/release/python.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` *{`Optional[str]`}* +
+**Example:** `https://plex.tv/updater/releases/5136` + +--- +##### `version` *{`Optional[str]`}* +
+**Example:** `1.40.0.7775-456fbaf97` + +--- +##### `added` *{`Optional[str]`}* +
+**Example:** `(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish. +(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793) +(Music) Store track genres and add filtering options (#14653) +(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653) +(View History) No longer create a view history entry for items marked as played (#10888) +(Web) Updated to 4.118.0` + +--- +##### `fixed` *{`Optional[str]`}* +
+**Example:** `(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483) +(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654) +(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667) +(Collection) Server could become unresponsive when collection membership changes (#14612) +(DVR) Previously watched recordings could be deleted without being watched again (#13779) +(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501) +(Library) The Content Rating not equal to None filter does not work (#14620) +(Search) Album search results could contain all the album's tracks too (#14486) +(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674) +(Transcoder) HW encoding would fail on devices with no rate control (#14222) +(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)` + +--- +##### `download_url` *{`Optional[str]`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `state` *{`Optional[str]`}* +
+**Example:** `notify` + + diff --git a/content/types/models/operations/release/typescript.mdx b/content/types/models/operations/release/typescript.mdx new file mode 100644 index 0000000..6fd67af --- /dev/null +++ b/content/types/models/operations/release/typescript.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key?`: *{`string`}* +
+**Example:** `https://plex.tv/updater/releases/5136` + +--- +##### `version?`: *{`string`}* +
+**Example:** `1.40.0.7775-456fbaf97` + +--- +##### `added?`: *{`string`}* +
+**Example:** `(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish. +(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793) +(Music) Store track genres and add filtering options (#14653) +(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653) +(View History) No longer create a view history entry for items marked as played (#10888) +(Web) Updated to 4.118.0` + +--- +##### `fixed?`: *{`string`}* +
+**Example:** `(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483) +(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654) +(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667) +(Collection) Server could become unresponsive when collection membership changes (#14612) +(DVR) Previously watched recordings could be deleted without being watched again (#13779) +(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501) +(Library) The Content Rating not equal to None filter does not work (#14620) +(Search) Album search results could contain all the album's tracks too (#14486) +(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674) +(Transcoder) HW encoding would fail on devices with no rate control (#14222) +(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)` + +--- +##### `downloadURL?`: *{`string`}* +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `state?`: *{`string`}* +
+**Example:** `notify` + + diff --git a/content/types/models/operations/session/go.mdx b/content/types/models/operations/session/go.mdx new file mode 100644 index 0000000..55bf3ff --- /dev/null +++ b/content/types/models/operations/session/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*string`}* +
+**Example:** `93h7e00ncblxncqw9lkfaoxi` + +--- +##### `Bandwidth` *{`*int`}* +
+**Example:** `1050` + +--- +##### `Location` *{`*string`}* +
+**Example:** `lan` + + diff --git a/content/types/models/operations/session/python.mdx b/content/types/models/operations/session/python.mdx new file mode 100644 index 0000000..75ef47e --- /dev/null +++ b/content/types/models/operations/session/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[str]`}* +
+**Example:** `93h7e00ncblxncqw9lkfaoxi` + +--- +##### `bandwidth` *{`Optional[int]`}* +
+**Example:** `1050` + +--- +##### `location` *{`Optional[str]`}* +
+**Example:** `lan` + + diff --git a/content/types/models/operations/session/typescript.mdx b/content/types/models/operations/session/typescript.mdx new file mode 100644 index 0000000..218c4e0 --- /dev/null +++ b/content/types/models/operations/session/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`string`}* +
+**Example:** `93h7e00ncblxncqw9lkfaoxi` + +--- +##### `bandwidth?`: *{`number`}* +
+**Example:** `1050` + +--- +##### `location?`: *{`string`}* +
+**Example:** `lan` + + diff --git a/content/types/models/operations/setting/go.mdx b/content/types/models/operations/setting/go.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/types/models/operations/setting/go.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/types/models/operations/setting/python.mdx b/content/types/models/operations/setting/python.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/types/models/operations/setting/python.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/types/models/operations/setting/typescript.mdx b/content/types/models/operations/setting/typescript.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/types/models/operations/setting/typescript.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/types/models/operations/sort/go.mdx b/content/types/models/operations/sort/go.mdx new file mode 100644 index 0000000..3e48234 --- /dev/null +++ b/content/types/models/operations/sort/go.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Default` *{`*string`}* +
+**Example:** `asc` + +--- +##### `DefaultDirection` *{`*string`}* +
+**Example:** `desc` + +--- +##### `DescKey` *{`*string`}* +
+**Example:** `random:desc` + +--- +##### `FirstCharacterKey` *{`*string`}* +
+**Example:** `/library/sections/1/firstCharacter` + +--- +##### `Key` *{`*string`}* +
+**Example:** `random` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Randomly` + + diff --git a/content/types/models/operations/sort/python.mdx b/content/types/models/operations/sort/python.mdx new file mode 100644 index 0000000..3e86e39 --- /dev/null +++ b/content/types/models/operations/sort/python.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `default` *{`Optional[str]`}* +
+**Example:** `asc` + +--- +##### `default_direction` *{`Optional[str]`}* +
+**Example:** `desc` + +--- +##### `desc_key` *{`Optional[str]`}* +
+**Example:** `random:desc` + +--- +##### `first_character_key` *{`Optional[str]`}* +
+**Example:** `/library/sections/1/firstCharacter` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `random` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Randomly` + + diff --git a/content/types/models/operations/sort/typescript.mdx b/content/types/models/operations/sort/typescript.mdx new file mode 100644 index 0000000..409579d --- /dev/null +++ b/content/types/models/operations/sort/typescript.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `default?`: *{`string`}* +
+**Example:** `asc` + +--- +##### `defaultDirection?`: *{`string`}* +
+**Example:** `desc` + +--- +##### `descKey?`: *{`string`}* +
+**Example:** `random:desc` + +--- +##### `firstCharacterKey?`: *{`string`}* +
+**Example:** `/library/sections/1/firstCharacter` + +--- +##### `key?`: *{`string`}* +
+**Example:** `random` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Randomly` + + diff --git a/content/types/models/operations/stream/go.mdx b/content/types/models/operations/stream/go.mdx index 6ad0a2a..175bc0a 100644 --- a/content/types/models/operations/stream/go.mdx +++ b/content/types/models/operations/stream/go.mdx @@ -1,30 +1,142 @@ {/* Autogenerated DO NOT EDIT */} -##### `ID` *{`*float64`}* +##### `ID` *{`*int`}*
-**Example:** `211234` +**Example:** `29` --- -##### `StreamType` *{`*float64`}* +##### `StreamType` *{`*int`}*
-**Example:** `1` +**Example:** `2` --- ##### `Default` *{`*bool`}* +
+**Example:** `true` --- ##### `Codec` *{`*string`}*
-**Example:** `hevc` +**Example:** `aac` --- -##### `Index` *{`*float64`}* +##### `Index` *{`*int`}*
**Example:** `0` --- -##### `Bitrate` *{`*float64`}* +##### `Bitrate` *{`*int`}*
-**Example:** `918` +**Example:** `128` + +--- +##### `BitDepth` *{`*int`}* +
+**Example:** `8` + +--- +##### `ChromaLocation` *{`*string`}* +
+**Example:** `left` + +--- +##### `ChromaSubsampling` *{`*string`}* +
+**Example:** `14520` + +--- +##### `CodedHeight` *{`*int`}* +
+**Example:** `816` + +--- +##### `CodedWidth` *{`*int`}* +
+**Example:** `1920` + +--- +##### `ColorPrimaries` *{`*string`}* +
+**Example:** `bt709` + +--- +##### `ColorRange` *{`*string`}* +
+**Example:** `tv` + +--- +##### `ColorSpace` *{`*string`}* +
+**Example:** `bt709` + +--- +##### `ColorTrc` *{`*string`}* +
+**Example:** `bt709` + +--- +##### `FrameRate` *{`*int`}* +
+**Example:** `24` + +--- +##### `HasScalingMatrix` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Height` *{`*int`}* +
+**Example:** `814` + +--- +##### `Level` *{`*int`}* +
+**Example:** `40` + +--- +##### `Profile` *{`*string`}* +
+**Example:** `lc` + +--- +##### `RefFrames` *{`*int`}* +
+**Example:** `4` + +--- +##### `ScanType` *{`*string`}* +
+**Example:** `progressive` + +--- +##### `StreamIdentifier` *{`*string`}* +
+**Example:** `1` + +--- +##### `Width` *{`*int`}* +
+**Example:** `1920` + +--- +##### `DisplayTitle` *{`*string`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `ExtendedDisplayTitle` *{`*string`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `Selected` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Channels` *{`*int`}* +
+**Example:** `2` --- ##### `Language` *{`*string`}* @@ -42,73 +154,8 @@ **Example:** `eng` --- -##### `BitDepth` *{`*float64`}* +##### `SamplingRate` *{`*int`}*
-**Example:** `8` - ---- -##### `ChromaLocation` *{`*string`}* -
-**Example:** `left` - ---- -##### `ChromaSubsampling` *{`*string`}* -
-**Example:** `4:2:0` - ---- -##### `CodedHeight` *{`*float64`}* -
-**Example:** `1080` - ---- -##### `CodedWidth` *{`*float64`}* -
-**Example:** `1920` - ---- -##### `ColorRange` *{`*string`}* -
-**Example:** `tv` - ---- -##### `FrameRate` *{`*float64`}* -
-**Example:** `25` - ---- -##### `Height` *{`*float64`}* -
-**Example:** `1080` - ---- -##### `Level` *{`*float64`}* -
-**Example:** `120` - ---- -##### `Profile` *{`*string`}* -
-**Example:** `main` - ---- -##### `RefFrames` *{`*float64`}* -
-**Example:** `1` - ---- -##### `Width` *{`*float64`}* -
-**Example:** `1920` - ---- -##### `DisplayTitle` *{`*string`}* -
-**Example:** `1080p (HEVC Main)` - ---- -##### `ExtendedDisplayTitle` *{`*string`}* -
-**Example:** `1080p (HEVC Main)` +**Example:** `44100` diff --git a/content/types/models/operations/stream/python.mdx b/content/types/models/operations/stream/python.mdx index 595d01d..adef3b4 100644 --- a/content/types/models/operations/stream/python.mdx +++ b/content/types/models/operations/stream/python.mdx @@ -1,30 +1,142 @@ {/* Autogenerated DO NOT EDIT */} -##### `id` *{`Optional[float]`}* +##### `id` *{`Optional[int]`}*
-**Example:** `211234` +**Example:** `29` --- -##### `stream_type` *{`Optional[float]`}* +##### `stream_type` *{`Optional[int]`}*
-**Example:** `1` +**Example:** `2` --- ##### `default` *{`Optional[bool]`}* +
+**Example:** `true` --- ##### `codec` *{`Optional[str]`}*
-**Example:** `hevc` +**Example:** `aac` --- -##### `index` *{`Optional[float]`}* +##### `index` *{`Optional[int]`}*
**Example:** `0` --- -##### `bitrate` *{`Optional[float]`}* +##### `bitrate` *{`Optional[int]`}*
-**Example:** `918` +**Example:** `128` + +--- +##### `bit_depth` *{`Optional[int]`}* +
+**Example:** `8` + +--- +##### `chroma_location` *{`Optional[str]`}* +
+**Example:** `left` + +--- +##### `chroma_subsampling` *{`Optional[str]`}* +
+**Example:** `14520` + +--- +##### `coded_height` *{`Optional[int]`}* +
+**Example:** `816` + +--- +##### `coded_width` *{`Optional[int]`}* +
+**Example:** `1920` + +--- +##### `color_primaries` *{`Optional[str]`}* +
+**Example:** `bt709` + +--- +##### `color_range` *{`Optional[str]`}* +
+**Example:** `tv` + +--- +##### `color_space` *{`Optional[str]`}* +
+**Example:** `bt709` + +--- +##### `color_trc` *{`Optional[str]`}* +
+**Example:** `bt709` + +--- +##### `frame_rate` *{`Optional[int]`}* +
+**Example:** `24` + +--- +##### `has_scaling_matrix` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `height` *{`Optional[int]`}* +
+**Example:** `814` + +--- +##### `level` *{`Optional[int]`}* +
+**Example:** `40` + +--- +##### `profile` *{`Optional[str]`}* +
+**Example:** `lc` + +--- +##### `ref_frames` *{`Optional[int]`}* +
+**Example:** `4` + +--- +##### `scan_type` *{`Optional[str]`}* +
+**Example:** `progressive` + +--- +##### `stream_identifier` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `width` *{`Optional[int]`}* +
+**Example:** `1920` + +--- +##### `display_title` *{`Optional[str]`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `extended_display_title` *{`Optional[str]`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `selected` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `channels` *{`Optional[int]`}* +
+**Example:** `2` --- ##### `language` *{`Optional[str]`}* @@ -42,73 +154,8 @@ **Example:** `eng` --- -##### `bit_depth` *{`Optional[float]`}* +##### `sampling_rate` *{`Optional[int]`}*
-**Example:** `8` - ---- -##### `chroma_location` *{`Optional[str]`}* -
-**Example:** `left` - ---- -##### `chroma_subsampling` *{`Optional[str]`}* -
-**Example:** `4:2:0` - ---- -##### `coded_height` *{`Optional[float]`}* -
-**Example:** `1080` - ---- -##### `coded_width` *{`Optional[float]`}* -
-**Example:** `1920` - ---- -##### `color_range` *{`Optional[str]`}* -
-**Example:** `tv` - ---- -##### `frame_rate` *{`Optional[float]`}* -
-**Example:** `25` - ---- -##### `height` *{`Optional[float]`}* -
-**Example:** `1080` - ---- -##### `level` *{`Optional[float]`}* -
-**Example:** `120` - ---- -##### `profile` *{`Optional[str]`}* -
-**Example:** `main` - ---- -##### `ref_frames` *{`Optional[float]`}* -
-**Example:** `1` - ---- -##### `width` *{`Optional[float]`}* -
-**Example:** `1920` - ---- -##### `display_title` *{`Optional[str]`}* -
-**Example:** `1080p (HEVC Main)` - ---- -##### `extended_display_title` *{`Optional[str]`}* -
-**Example:** `1080p (HEVC Main)` +**Example:** `44100` diff --git a/content/types/models/operations/stream/typescript.mdx b/content/types/models/operations/stream/typescript.mdx index d079c58..74b4192 100644 --- a/content/types/models/operations/stream/typescript.mdx +++ b/content/types/models/operations/stream/typescript.mdx @@ -1,20 +1,22 @@ {/* Autogenerated DO NOT EDIT */} ##### `id?`: *{`number`}*
-**Example:** `211234` +**Example:** `29` --- ##### `streamType?`: *{`number`}*
-**Example:** `1` +**Example:** `2` --- ##### `default?`: *{`boolean`}* +
+**Example:** `true` --- ##### `codec?`: *{`string`}*
-**Example:** `hevc` +**Example:** `aac` --- ##### `index?`: *{`number`}* @@ -24,7 +26,117 @@ --- ##### `bitrate?`: *{`number`}*
-**Example:** `918` +**Example:** `128` + +--- +##### `bitDepth?`: *{`number`}* +
+**Example:** `8` + +--- +##### `chromaLocation?`: *{`string`}* +
+**Example:** `left` + +--- +##### `chromaSubsampling?`: *{`string`}* +
+**Example:** `14520` + +--- +##### `codedHeight?`: *{`number`}* +
+**Example:** `816` + +--- +##### `codedWidth?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `colorPrimaries?`: *{`string`}* +
+**Example:** `bt709` + +--- +##### `colorRange?`: *{`string`}* +
+**Example:** `tv` + +--- +##### `colorSpace?`: *{`string`}* +
+**Example:** `bt709` + +--- +##### `colorTrc?`: *{`string`}* +
+**Example:** `bt709` + +--- +##### `frameRate?`: *{`number`}* +
+**Example:** `24` + +--- +##### `hasScalingMatrix?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `height?`: *{`number`}* +
+**Example:** `814` + +--- +##### `level?`: *{`number`}* +
+**Example:** `40` + +--- +##### `profile?`: *{`string`}* +
+**Example:** `lc` + +--- +##### `refFrames?`: *{`number`}* +
+**Example:** `4` + +--- +##### `scanType?`: *{`string`}* +
+**Example:** `progressive` + +--- +##### `streamIdentifier?`: *{`string`}* +
+**Example:** `1` + +--- +##### `width?`: *{`number`}* +
+**Example:** `1920` + +--- +##### `displayTitle?`: *{`string`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `extendedDisplayTitle?`: *{`string`}* +
+**Example:** `English (AAC Stereo)` + +--- +##### `selected?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `channels?`: *{`number`}* +
+**Example:** `2` --- ##### `language?`: *{`string`}* @@ -42,73 +154,8 @@ **Example:** `eng` --- -##### `bitDepth?`: *{`number`}* +##### `samplingRate?`: *{`number`}*
-**Example:** `8` - ---- -##### `chromaLocation?`: *{`string`}* -
-**Example:** `left` - ---- -##### `chromaSubsampling?`: *{`string`}* -
-**Example:** `4:2:0` - ---- -##### `codedHeight?`: *{`number`}* -
-**Example:** `1080` - ---- -##### `codedWidth?`: *{`number`}* -
-**Example:** `1920` - ---- -##### `colorRange?`: *{`string`}* -
-**Example:** `tv` - ---- -##### `frameRate?`: *{`number`}* -
-**Example:** `25` - ---- -##### `height?`: *{`number`}* -
-**Example:** `1080` - ---- -##### `level?`: *{`number`}* -
-**Example:** `120` - ---- -##### `profile?`: *{`string`}* -
-**Example:** `main` - ---- -##### `refFrames?`: *{`number`}* -
-**Example:** `1` - ---- -##### `width?`: *{`number`}* -
-**Example:** `1920` - ---- -##### `displayTitle?`: *{`string`}* -
-**Example:** `1080p (HEVC Main)` - ---- -##### `extendedDisplayTitle?`: *{`string`}* -
-**Example:** `1080p (HEVC Main)` +**Example:** `44100` diff --git a/content/types/models/operations/tag/go.mdx b/content/types/models/operations/tag/go.mdx new file mode 100644 index 0000000..45730ae --- /dev/null +++ b/content/types/models/operations/tag/go.mdx @@ -0,0 +1,25 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------------ | ------------------ | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | +| `searchTypeEqual1` | search?type=1 | + diff --git a/content/types/models/operations/tag/python.mdx b/content/types/models/operations/tag/python.mdx new file mode 100644 index 0000000..45730ae --- /dev/null +++ b/content/types/models/operations/tag/python.mdx @@ -0,0 +1,25 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------------ | ------------------ | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | +| `searchTypeEqual1` | search?type=1 | + diff --git a/content/types/models/operations/tag/typescript.mdx b/content/types/models/operations/tag/typescript.mdx new file mode 100644 index 0000000..45730ae --- /dev/null +++ b/content/types/models/operations/tag/typescript.mdx @@ -0,0 +1,25 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------------ | ------------------ | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | +| `searchTypeEqual1` | search?type=1 | + diff --git a/content/types/models/operations/transcode_session/go.mdx b/content/types/models/operations/transcode_session/go.mdx index d766ca2..0b17123 100644 --- a/content/types/models/operations/transcode_session/go.mdx +++ b/content/types/models/operations/transcode_session/go.mdx @@ -1,36 +1,47 @@ {/* Autogenerated DO NOT EDIT */} ##### `Key` *{`*string`}*
-**Example:** `zz7llzqlx8w9vnrsbnwhbmep` +**Example:** `vv3i2q2lax92qlzul1hbd4bx` --- ##### `Throttled` *{`*bool`}* +
+**Example:** `false` --- ##### `Complete` *{`*bool`}* +
+**Example:** `false` --- ##### `Progress` *{`*float64`}*
-**Example:** `0.4000000059604645` +**Example:** `1.7999999523162842` --- -##### `Size` *{`*float64`}* +##### `Size` *{`*int`}*
**Example:** `-22` --- ##### `Speed` *{`*float64`}*
-**Example:** `22.399999618530273` +**Example:** `25.100000381469727` --- ##### `Error` *{`*bool`}* +
+**Example:** `false` --- -##### `Duration` *{`*float64`}* +##### `Duration` *{`*int`}*
-**Example:** `2561768` +**Example:** `1445695` + +--- +##### `Remaining` *{`*int`}* +
+**Example:** `53` --- ##### `Context` *{`*string`}* @@ -45,7 +56,7 @@ --- ##### `SourceAudioCodec` *{`*string`}*
-**Example:** `ac3` +**Example:** `aac` --- ##### `VideoDecision` *{`*string`}* @@ -57,6 +68,11 @@
**Example:** `transcode` +--- +##### `SubtitleDecision` *{`*string`}* +
+**Example:** `burn` + --- ##### `Protocol` *{`*string`}*
@@ -78,26 +94,28 @@ **Example:** `opus` --- -##### `AudioChannels` *{`*float64`}* +##### `AudioChannels` *{`*int`}*
-**Example:** `2` +**Example:** `1` --- ##### `TranscodeHwRequested` *{`*bool`}* +
+**Example:** `true` --- ##### `TimeStamp` *{`*float64`}*
-**Example:** `1.6818695357764285e+09` +**Example:** `1.7058958054919229e+09` --- ##### `MaxOffsetAvailable` *{`*float64`}*
-**Example:** `861.778` +**Example:** `29.53` --- ##### `MinOffsetAvailable` *{`*float64`}*
-**Example:** `0` +**Example:** `3.003000020980835` diff --git a/content/types/models/operations/transcode_session/python.mdx b/content/types/models/operations/transcode_session/python.mdx index 57de1c2..728f20f 100644 --- a/content/types/models/operations/transcode_session/python.mdx +++ b/content/types/models/operations/transcode_session/python.mdx @@ -1,36 +1,47 @@ {/* Autogenerated DO NOT EDIT */} ##### `key` *{`Optional[str]`}*
-**Example:** `zz7llzqlx8w9vnrsbnwhbmep` +**Example:** `vv3i2q2lax92qlzul1hbd4bx` --- ##### `throttled` *{`Optional[bool]`}* +
+**Example:** `false` --- ##### `complete` *{`Optional[bool]`}* +
+**Example:** `false` --- ##### `progress` *{`Optional[float]`}*
-**Example:** `0.4000000059604645` +**Example:** `1.7999999523162842` --- -##### `size` *{`Optional[float]`}* +##### `size` *{`Optional[int]`}*
**Example:** `-22` --- ##### `speed` *{`Optional[float]`}*
-**Example:** `22.399999618530273` +**Example:** `25.100000381469727` --- ##### `error` *{`Optional[bool]`}* +
+**Example:** `false` --- -##### `duration` *{`Optional[float]`}* +##### `duration` *{`Optional[int]`}*
-**Example:** `2561768` +**Example:** `1445695` + +--- +##### `remaining` *{`Optional[int]`}* +
+**Example:** `53` --- ##### `context` *{`Optional[str]`}* @@ -45,7 +56,7 @@ --- ##### `source_audio_codec` *{`Optional[str]`}*
-**Example:** `ac3` +**Example:** `aac` --- ##### `video_decision` *{`Optional[str]`}* @@ -57,6 +68,11 @@
**Example:** `transcode` +--- +##### `subtitle_decision` *{`Optional[str]`}* +
+**Example:** `burn` + --- ##### `protocol` *{`Optional[str]`}*
@@ -78,26 +94,28 @@ **Example:** `opus` --- -##### `audio_channels` *{`Optional[float]`}* +##### `audio_channels` *{`Optional[int]`}*
-**Example:** `2` +**Example:** `1` --- ##### `transcode_hw_requested` *{`Optional[bool]`}* +
+**Example:** `true` --- ##### `time_stamp` *{`Optional[float]`}*
-**Example:** `1.6818695357764285e+09` +**Example:** `1.7058958054919229e+09` --- ##### `max_offset_available` *{`Optional[float]`}*
-**Example:** `861.778` +**Example:** `29.53` --- ##### `min_offset_available` *{`Optional[float]`}*
-**Example:** `0` +**Example:** `3.003000020980835` diff --git a/content/types/models/operations/transcode_session/typescript.mdx b/content/types/models/operations/transcode_session/typescript.mdx index c3a64a9..b50fe3d 100644 --- a/content/types/models/operations/transcode_session/typescript.mdx +++ b/content/types/models/operations/transcode_session/typescript.mdx @@ -1,18 +1,22 @@ {/* Autogenerated DO NOT EDIT */} ##### `key?`: *{`string`}*
-**Example:** `zz7llzqlx8w9vnrsbnwhbmep` +**Example:** `vv3i2q2lax92qlzul1hbd4bx` --- ##### `throttled?`: *{`boolean`}* +
+**Example:** `false` --- ##### `complete?`: *{`boolean`}* +
+**Example:** `false` --- ##### `progress?`: *{`number`}*
-**Example:** `0.4000000059604645` +**Example:** `1.7999999523162842` --- ##### `size?`: *{`number`}* @@ -22,15 +26,22 @@ --- ##### `speed?`: *{`number`}*
-**Example:** `22.399999618530273` +**Example:** `25.100000381469727` --- ##### `error?`: *{`boolean`}* +
+**Example:** `false` --- ##### `duration?`: *{`number`}*
-**Example:** `2561768` +**Example:** `1445695` + +--- +##### `remaining?`: *{`number`}* +
+**Example:** `53` --- ##### `context?`: *{`string`}* @@ -45,7 +56,7 @@ --- ##### `sourceAudioCodec?`: *{`string`}*
-**Example:** `ac3` +**Example:** `aac` --- ##### `videoDecision?`: *{`string`}* @@ -57,6 +68,11 @@
**Example:** `transcode` +--- +##### `subtitleDecision?`: *{`string`}* +
+**Example:** `burn` + --- ##### `protocol?`: *{`string`}*
@@ -80,24 +96,26 @@ --- ##### `audioChannels?`: *{`number`}*
-**Example:** `2` +**Example:** `1` --- ##### `transcodeHwRequested?`: *{`boolean`}* +
+**Example:** `true` --- ##### `timeStamp?`: *{`number`}*
-**Example:** `1.6818695357764285e+09` +**Example:** `1.7058958054919229e+09` --- ##### `maxOffsetAvailable?`: *{`number`}*
-**Example:** `861.778` +**Example:** `29.53` --- ##### `minOffsetAvailable?`: *{`number`}*
-**Example:** `0` +**Example:** `3.003000020980835` diff --git a/content/types/models/operations/two/go.mdx b/content/types/models/operations/two/go.mdx new file mode 100644 index 0000000..b62c79d --- /dev/null +++ b/content/types/models/operations/two/go.mdx @@ -0,0 +1,49 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*string`}* +
+**Example:** `ScheduledLibraryUpdateInterval` + +--- +##### `Label` *{`*string`}* +
+**Example:** `Library scan interval` + +--- +##### `Summary` *{`*string`}* + +--- +##### `Type` *{`*string`}* +
+**Example:** `int` + +--- +##### `Default` *{`*int`}* +
+**Example:** `3600` + +--- +##### `Value` *{`*int`}* +
+**Example:** `3600` + +--- +##### `Hidden` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Advanced` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Group` *{`*string`}* +
+**Example:** `library` + +--- +##### `EnumValues` *{`*string`}* +
+**Example:** `900:every 15 minutes|1800:every 30 minutes|3600:hourly|7200:every 2 hours|21600:every 6 hours|43200:every 12 hours|86400:daily` + + diff --git a/content/types/models/operations/two/python.mdx b/content/types/models/operations/two/python.mdx new file mode 100644 index 0000000..055d588 --- /dev/null +++ b/content/types/models/operations/two/python.mdx @@ -0,0 +1,49 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[str]`}* +
+**Example:** `ScheduledLibraryUpdateInterval` + +--- +##### `label` *{`Optional[str]`}* +
+**Example:** `Library scan interval` + +--- +##### `summary` *{`Optional[str]`}* + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `int` + +--- +##### `default` *{`Optional[int]`}* +
+**Example:** `3600` + +--- +##### `value` *{`Optional[int]`}* +
+**Example:** `3600` + +--- +##### `hidden` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `advanced` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `group` *{`Optional[str]`}* +
+**Example:** `library` + +--- +##### `enum_values` *{`Optional[str]`}* +
+**Example:** `900:every 15 minutes|1800:every 30 minutes|3600:hourly|7200:every 2 hours|21600:every 6 hours|43200:every 12 hours|86400:daily` + + diff --git a/content/types/models/operations/two/typescript.mdx b/content/types/models/operations/two/typescript.mdx new file mode 100644 index 0000000..0ab7e1e --- /dev/null +++ b/content/types/models/operations/two/typescript.mdx @@ -0,0 +1,49 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`string`}* +
+**Example:** `ScheduledLibraryUpdateInterval` + +--- +##### `label?`: *{`string`}* +
+**Example:** `Library scan interval` + +--- +##### `summary?`: *{`string`}* + +--- +##### `type?`: *{`string`}* +
+**Example:** `int` + +--- +##### `default?`: *{`number`}* +
+**Example:** `3600` + +--- +##### `value?`: *{`number`}* +
+**Example:** `3600` + +--- +##### `hidden?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `advanced?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `group?`: *{`string`}* +
+**Example:** `library` + +--- +##### `enumValues?`: *{`string`}* +
+**Example:** `900:every 15 minutes|1800:every 30 minutes|3600:hourly|7200:every 2 hours|21600:every 6 hours|43200:every 12 hours|86400:daily` + + diff --git a/content/types/models/operations/update_playlist_request/go.mdx b/content/types/models/operations/update_playlist_request/go.mdx index 3fa4161..c25582b 100644 --- a/content/types/models/operations/update_playlist_request/go.mdx +++ b/content/types/models/operations/update_playlist_request/go.mdx @@ -2,4 +2,12 @@ ##### `PlaylistID` *{`float64`}* the ID of the playlist +--- +##### `Title` *{`*string`}* +name of the playlist + +--- +##### `Summary` *{`*string`}* +summary description of the playlist + diff --git a/content/types/models/operations/update_playlist_request/python.mdx b/content/types/models/operations/update_playlist_request/python.mdx index dc9466c..3e33548 100644 --- a/content/types/models/operations/update_playlist_request/python.mdx +++ b/content/types/models/operations/update_playlist_request/python.mdx @@ -2,4 +2,12 @@ ##### `playlist_id` *{`float`}* the ID of the playlist +--- +##### `title` *{`Optional[str]`}* +name of the playlist + +--- +##### `summary` *{`Optional[str]`}* +summary description of the playlist + diff --git a/content/types/models/operations/update_playlist_request/typescript.mdx b/content/types/models/operations/update_playlist_request/typescript.mdx index 00b5b5c..9fa2222 100644 --- a/content/types/models/operations/update_playlist_request/typescript.mdx +++ b/content/types/models/operations/update_playlist_request/typescript.mdx @@ -2,4 +2,12 @@ ##### `playlistID`: *{`number`}* the ID of the playlist +--- +##### `title?`: *{`string`}* +name of the playlist + +--- +##### `summary?`: *{`string`}* +summary description of the playlist + diff --git a/content/types/models/operations/upload_playlist_request/go.mdx b/content/types/models/operations/upload_playlist_request/go.mdx index 91a6c2e..ddf0a4a 100644 --- a/content/types/models/operations/upload_playlist_request/go.mdx +++ b/content/types/models/operations/upload_playlist_request/go.mdx @@ -15,8 +15,10 @@ The GUID of each playlist is based on the filename. --- ##### `Force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. import('/content/types/models/operations/force/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/upload_playlist_request/python.mdx b/content/types/models/operations/upload_playlist_request/python.mdx index e133ad8..6cf55a8 100644 --- a/content/types/models/operations/upload_playlist_request/python.mdx +++ b/content/types/models/operations/upload_playlist_request/python.mdx @@ -15,8 +15,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. import('/content/types/models/operations/force/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/upload_playlist_request/typescript.mdx b/content/types/models/operations/upload_playlist_request/typescript.mdx index 5ba5b35..0b86ee5 100644 --- a/content/types/models/operations/upload_playlist_request/typescript.mdx +++ b/content/types/models/operations/upload_playlist_request/typescript.mdx @@ -15,8 +15,10 @@ The GUID of each playlist is based on the filename. --- ##### `force`: *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. import('/content/types/models/operations/force/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/user/go.mdx b/content/types/models/operations/user/go.mdx new file mode 100644 index 0000000..edd52dc --- /dev/null +++ b/content/types/models/operations/user/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ID` *{`*string`}* +
+**Example:** `1` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Blindkitty38` + + diff --git a/content/types/models/operations/user/python.mdx b/content/types/models/operations/user/python.mdx new file mode 100644 index 0000000..238df1b --- /dev/null +++ b/content/types/models/operations/user/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Blindkitty38` + + diff --git a/content/types/models/operations/user/typescript.mdx b/content/types/models/operations/user/typescript.mdx new file mode 100644 index 0000000..7b51233 --- /dev/null +++ b/content/types/models/operations/user/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id?`: *{`string`}* +
+**Example:** `1` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Blindkitty38` + + diff --git a/content/types/models/sdkerrors/get_common_library_items_errors/go.mdx b/content/types/models/sdkerrors/get_common_library_items_errors/go.mdx deleted file mode 100644 index e4612a8..0000000 --- a/content/types/models/sdkerrors/get_common_library_items_errors/go.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `Code` *{`*float64`}* -
-**Example:** `1001` - ---- -##### `Message` *{`*string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `Status` *{`*float64`}* -
-**Example:** `401` - - diff --git a/content/types/models/sdkerrors/get_common_library_items_response_body/go.mdx b/content/types/models/sdkerrors/get_common_library_items_response_body/go.mdx deleted file mode 100644 index 67e839c..0000000 --- a/content/types/models/sdkerrors/get_common_library_items_response_body/go.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `Errors` *{`[]sdkerrors.GetCommonLibraryItemsErrors`}* - - import('/content/types/models/sdkerrors/get_common_library_items_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx b/content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx deleted file mode 100644 index e4612a8..0000000 --- a/content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `Code` *{`*float64`}* -
-**Example:** `1001` - ---- -##### `Message` *{`*string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `Status` *{`*float64`}* -
-**Example:** `401` - - diff --git a/content/types/models/sdkerrors/get_latest_library_items_response_body/go.mdx b/content/types/models/sdkerrors/get_latest_library_items_response_body/go.mdx deleted file mode 100644 index b044835..0000000 --- a/content/types/models/sdkerrors/get_latest_library_items_response_body/go.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `Errors` *{`[]sdkerrors.GetLatestLibraryItemsErrors`}* - - import('/content/types/models/sdkerrors/get_latest_library_items_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/sdkerrors/get_library_items_errors/go.mdx b/content/types/models/sdkerrors/get_library_items_errors/go.mdx deleted file mode 100644 index e4612a8..0000000 --- a/content/types/models/sdkerrors/get_library_items_errors/go.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `Code` *{`*float64`}* -
-**Example:** `1001` - ---- -##### `Message` *{`*string`}* -
-**Example:** `User could not be authenticated` - ---- -##### `Status` *{`*float64`}* -
-**Example:** `401` - - diff --git a/content/types/models/sdkerrors/get_library_items_response_body/go.mdx b/content/types/models/sdkerrors/get_library_items_response_body/go.mdx deleted file mode 100644 index 2cca7b8..0000000 --- a/content/types/models/sdkerrors/get_library_items_response_body/go.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `Errors` *{`[]sdkerrors.GetLibraryItemsErrors`}* - - import('/content/types/models/sdkerrors/get_library_items_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/operations/add_playlist_contents_media_container/curl.mdx b/content/types/operations/add_playlist_contents_media_container/curl.mdx new file mode 100644 index 0000000..376a50e --- /dev/null +++ b/content/types/operations/add_playlist_contents_media_container/curl.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `leafCountAdded` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `leafCountRequested` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}]` + + diff --git a/content/types/operations/add_playlist_contents_metadata/curl.mdx b/content/types/operations/add_playlist_contents_metadata/curl.mdx new file mode 100644 index 0000000..d4594ee --- /dev/null +++ b/content/types/operations/add_playlist_contents_metadata/curl.mdx @@ -0,0 +1,66 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `94` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/94/items` + +--- +##### `guid` _string (optional)_ +
+**Example:** `com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `title` _string (optional)_ +
+**Example:** `A great playlist` + +--- +##### `summary` _string (optional)_ +
+**Example:** `One of my great playlists` + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/94/composite/1705800070` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `423000` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `3` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705716458` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705800070` + + diff --git a/content/types/operations/get_common_library_items_response_body/curl.mdx b/content/types/operations/add_playlist_contents_playlists_response_body/curl.mdx similarity index 100% rename from content/types/operations/get_common_library_items_response_body/curl.mdx rename to content/types/operations/add_playlist_contents_playlists_response_body/curl.mdx diff --git a/content/types/operations/add_playlist_contents_request/curl.mdx b/content/types/operations/add_playlist_contents_request/curl.mdx index 5d3e953..92082ad 100644 --- a/content/types/operations/add_playlist_contents_request/curl.mdx +++ b/content/types/operations/add_playlist_contents_request/curl.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` _string_ the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID` _number_ +##### `playQueueID` _number (optional)_ the play queue to add to a playlist
**Example:** `123` diff --git a/content/types/operations/add_playlist_contents_response/curl.mdx b/content/types/operations/add_playlist_contents_response/curl.mdx index b3b4dbd..c188e4c 100644 --- a/content/types/operations/add_playlist_contents_response/curl.mdx +++ b/content/types/operations/add_playlist_contents_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +Playlist Updated import('/content/types/operations/add_playlist_contents_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/add_playlist_contents_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/add_playlist_contents_response_body/curl.mdx b/content/types/operations/add_playlist_contents_response_body/curl.mdx index 91839c7..b524d5f 100644 --- a/content/types/operations/add_playlist_contents_response_body/curl.mdx +++ b/content/types/operations/add_playlist_contents_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/add_playlist_contents_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/create_playlist_media_container/curl.mdx b/content/types/operations/create_playlist_media_container/curl.mdx new file mode 100644 index 0000000..f0a7be2 --- /dev/null +++ b/content/types/operations/create_playlist_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `7` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}]` + + diff --git a/content/types/operations/create_playlist_metadata/curl.mdx b/content/types/operations/create_playlist_metadata/curl.mdx new file mode 100644 index 0000000..ea689f2 --- /dev/null +++ b/content/types/operations/create_playlist_metadata/curl.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `96` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/96/items` + +--- +##### `guid` _string (optional)_ +
+**Example:** `com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `title` _string (optional)_ +
+**Example:** `A Great Playlist` + +--- +##### `summary` _string (optional)_ +
+**Example:** `What a great playlist` + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `icon` _string (optional)_ +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705719589` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705719589` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705724593` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/96/composite/1705724593` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141000` + + diff --git a/content/types/operations/get_latest_library_items_response_body/curl.mdx b/content/types/operations/create_playlist_playlists_response_body/curl.mdx similarity index 100% rename from content/types/operations/get_latest_library_items_response_body/curl.mdx rename to content/types/operations/create_playlist_playlists_response_body/curl.mdx diff --git a/content/types/operations/create_playlist_request/curl.mdx b/content/types/operations/create_playlist_request/curl.mdx index 67d8968..223bec7 100644 --- a/content/types/operations/create_playlist_request/curl.mdx +++ b/content/types/operations/create_playlist_request/curl.mdx @@ -20,7 +20,7 @@ whether the playlist is smart or not --- -##### `uri` _string (optional)_ +##### `uri` _string_ the content URI for the playlist --- diff --git a/content/types/operations/create_playlist_response/curl.mdx b/content/types/operations/create_playlist_response/curl.mdx index 88c595c..a820ce0 100644 --- a/content/types/operations/create_playlist_response/curl.mdx +++ b/content/types/operations/create_playlist_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +returns all playlists import('/content/types/operations/create_playlist_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/create_playlist_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/create_playlist_response_body/curl.mdx b/content/types/operations/create_playlist_response_body/curl.mdx index 91839c7..ad9dd14 100644 --- a/content/types/operations/create_playlist_response_body/curl.mdx +++ b/content/types/operations/create_playlist_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/create_playlist_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/field/curl.mdx b/content/types/operations/field/curl.mdx new file mode 100644 index 0000000..0b0500f --- /dev/null +++ b/content/types/operations/field/curl.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `label` + +--- +##### `title` _string (optional)_ +
+**Example:** `Label` + +--- +##### `type` _string (optional)_ +
+**Example:** `tag` + +--- +##### `subType` _string (optional)_ +
+**Example:** `bitrate` + + diff --git a/content/types/operations/field_type/curl.mdx b/content/types/operations/field_type/curl.mdx new file mode 100644 index 0000000..68a645e --- /dev/null +++ b/content/types/operations/field_type/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `type` _string (optional)_ +
+**Example:** `resolution` + +--- +##### `operator` _array (optional)_ +
+**Example:** `[{"key":"=","title":"is"}]` + + diff --git a/content/types/operations/filter/curl.mdx b/content/types/operations/filter/curl.mdx new file mode 100644 index 0000000..2f2f65e --- /dev/null +++ b/content/types/operations/filter/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `filter` _string (optional)_ +
+**Example:** `label` + +--- +##### `filterType` _string (optional)_ +
+**Example:** `string` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/sections/1/label` + +--- +##### `title` _string (optional)_ +
+**Example:** `Labels` + +--- +##### `type` _string (optional)_ +
+**Example:** `filter` + + diff --git a/content/types/operations/get_available_clients_response/curl.mdx b/content/types/operations/get_available_clients_response/curl.mdx index 168dcd0..77c7203 100644 --- a/content/types/operations/get_available_clients_response/curl.mdx +++ b/content/types/operations/get_available_clients_response/curl.mdx @@ -14,14 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `classes` _array (optional)_ +##### `twoHundredApplicationJsonObject` _object (optional)_ Available Clients ---- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. - import('/content/types/operations/get_available_clients_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_available_clients_server_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_available_clients_response_body/curl.mdx b/content/types/operations/get_available_clients_response_body/curl.mdx index 91839c7..b7d16a9 100644 --- a/content/types/operations/get_available_clients_response_body/curl.mdx +++ b/content/types/operations/get_available_clients_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_available_clients_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_available_clients_server_response_body/curl.mdx b/content/types/operations/get_available_clients_server_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_available_clients_server_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_common_library_items_errors/curl.mdx b/content/types/operations/get_common_library_items_errors/curl.mdx deleted file mode 100644 index be78074..0000000 --- a/content/types/operations/get_common_library_items_errors/curl.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` _number (optional)_ -
-**Example:** `1001` - ---- -##### `message` _string (optional)_ -
-**Example:** `User could not be authenticated` - ---- -##### `status` _number (optional)_ -
-**Example:** `401` - - diff --git a/content/types/operations/get_common_library_items_request/curl.mdx b/content/types/operations/get_common_library_items_request/curl.mdx deleted file mode 100644 index 308c5db..0000000 --- a/content/types/operations/get_common_library_items_request/curl.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - - diff --git a/content/types/operations/get_common_library_items_response/curl.mdx b/content/types/operations/get_common_library_items_response/curl.mdx deleted file mode 100644 index 2648fe7..0000000 --- a/content/types/operations/get_common_library_items_response/curl.mdx +++ /dev/null @@ -1,23 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `contentType` _string_ -HTTP response content type for this operation - ---- -##### `statusCode` _integer (32-bit)_ -HTTP response status code for this operation - ---- -##### `rawResponse` _HTTP response_ -Raw HTTP response; suitable for custom response parsing - ---- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. - - import('/content/types/operations/get_common_library_items_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/operations/get_global_hubs_hubs_response_body/curl.mdx b/content/types/operations/get_global_hubs_hubs_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_global_hubs_hubs_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_global_hubs_media_container/curl.mdx b/content/types/operations/get_global_hubs_media_container/curl.mdx new file mode 100644 index 0000000..560a12f --- /dev/null +++ b/content/types/operations/get_global_hubs_media_container/curl.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `8` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `hub` _array (optional)_ +
+**Example:** `[{"Metadata":[{"addedAt":1655309388,"composite":"/playlists/50768/composite/1704333758","duration":42864000,"guid":"com.plexapp.agents.none://81658e0d-cd4e-4c73-abb9-832b2ae2037b","icon":"playlist://image.smart","key":"/playlists/50768/items","lastViewedAt":1705329935,"leafCount":178,"playlistType":"audio","ratingKey":"50768","smart":true,"summary":"All your highly rated tracks, in one convenient place.","title":"❤️ Tracks","titleSort":"Tracks","type":"playlist","updatedAt":1704333758,"viewCount":47},{"addedAt":1697993545,"composite":"/playlists/65523/composite/1698597932","duration":4864000,"guid":"com.plexapp.agents.none://1bcdd596-892b-4856-9f28-b4338c439300","key":"/playlists/65523/items","lastViewedAt":1698597949,"leafCount":19,"playlistType":"audio","ratingKey":"65523","smart":false,"summary":"","title":"Car Rides","type":"playlist","updatedAt":1698597932,"viewCount":2},{"addedAt":1679616785,"composite":"/playlists/58188/composite/1680825595","duration":12522000,"guid":"com.plexapp.agents.none://8f0441d3-2a28-4644-a2f1-b7deeb290dff","key":"/playlists/58188/items","lastViewedAt":1680825596,"leafCount":56,"playlistType":"audio","ratingKey":"58188","smart":false,"summary":"","title":"Workout","type":"playlist","updatedAt":1680825595,"viewCount":4},{"addedAt":1673372306,"composite":"/playlists/57341/composite/1673372385","duration":19119000,"guid":"com.plexapp.agents.none://bf8778c3-20a3-4619-8eb0-3c172c18ffd6","key":"/playlists/57341/items","lastViewedAt":1673372306,"leafCount":3,"playlistType":"video","ratingKey":"57341","smart":false,"summary":"","title":"January Movie Day","type":"playlist","updatedAt":1673372385,"viewCount":1},{"addedAt":1671197078,"composite":"/playlists/57302/composite/1671205874","duration":23040000,"guid":"com.plexapp.agents.none://f25064ed-05bb-4bcf-b70c-ed7514b70929","key":"/playlists/57302/items","lastViewedAt":1671206853,"leafCount":3,"playlistType":"video","ratingKey":"57302","smart":false,"summary":"","title":"December Movie Day","type":"playlist","updatedAt":1671205874,"viewCount":2},{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","type":"playlist","updatedAt":1668787730,"viewCount":2}],"context":"hub.home.playlists","hubIdentifier":"home.playlists","hubKey":"/library/metadata/50768,65523,58188,57341,57302,57070","key":"/playlists/all?type=15\u0026sort=lastViewedAt:desc\u0026playlistType=video,audio","more":true,"promoted":true,"size":6,"style":"shelf","title":"Recent Playlists","type":"playlist"}]` + + diff --git a/content/types/operations/get_global_hubs_metadata/curl.mdx b/content/types/operations/get_global_hubs_metadata/curl.mdx new file mode 100644 index 0000000..423d8c0 --- /dev/null +++ b/content/types/operations/get_global_hubs_metadata/curl.mdx @@ -0,0 +1,84 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `57070` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/57070/items` + +--- +##### `guid` _string (optional)_ +
+**Example:** `com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `title` _string (optional)_ +
+**Example:** `November Movie Day` + +--- +##### `titleSort` _string (optional)_ +
+**Example:** `Tracks` + +--- +##### `summary` _string (optional)_ + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/57070/composite/1668787730` + +--- +##### `icon` _string (optional)_ +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1668787732` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `16873000` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `3` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1668779618` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1668787730` + + diff --git a/content/types/operations/get_global_hubs_response/curl.mdx b/content/types/operations/get_global_hubs_response/curl.mdx index 297b555..d59ac81 100644 --- a/content/types/operations/get_global_hubs_response/curl.mdx +++ b/content/types/operations/get_global_hubs_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +returns global hubs import('/content/types/operations/get_global_hubs_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_global_hubs_hubs_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_global_hubs_response_body/curl.mdx b/content/types/operations/get_global_hubs_response_body/curl.mdx index 91839c7..b929b84 100644 --- a/content/types/operations/get_global_hubs_response_body/curl.mdx +++ b/content/types/operations/get_global_hubs_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_global_hubs_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_latest_library_items_errors/curl.mdx b/content/types/operations/get_latest_library_items_errors/curl.mdx deleted file mode 100644 index be78074..0000000 --- a/content/types/operations/get_latest_library_items_errors/curl.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` _number (optional)_ -
-**Example:** `1001` - ---- -##### `message` _string (optional)_ -
-**Example:** `User could not be authenticated` - ---- -##### `status` _number (optional)_ -
-**Example:** `401` - - diff --git a/content/types/operations/get_latest_library_items_request/curl.mdx b/content/types/operations/get_latest_library_items_request/curl.mdx deleted file mode 100644 index 308c5db..0000000 --- a/content/types/operations/get_latest_library_items_request/curl.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - - diff --git a/content/types/operations/get_latest_library_items_response/curl.mdx b/content/types/operations/get_latest_library_items_response/curl.mdx deleted file mode 100644 index 6b0f578..0000000 --- a/content/types/operations/get_latest_library_items_response/curl.mdx +++ /dev/null @@ -1,23 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `contentType` _string_ -HTTP response content type for this operation - ---- -##### `statusCode` _integer (32-bit)_ -HTTP response status code for this operation - ---- -##### `rawResponse` _HTTP response_ -Raw HTTP response; suitable for custom response parsing - ---- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. - - import('/content/types/operations/get_latest_library_items_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/operations/get_library_directory/curl.mdx b/content/types/operations/get_library_directory/curl.mdx new file mode 100644 index 0000000..9c5c172 --- /dev/null +++ b/content/types/operations/get_library_directory/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `search?type=1` + +--- +##### `title` _string (optional)_ +
+**Example:** `Search...` + +--- +##### `secondary` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `prompt` _string (optional)_ +
+**Example:** `Search Movies` + +--- +##### `search` _boolean (optional)_ +
+**Example:** `true` + + diff --git a/content/types/operations/get_library_hubs_country/curl.mdx b/content/types/operations/get_library_hubs_country/curl.mdx new file mode 100644 index 0000000..d45e2f2 --- /dev/null +++ b/content/types/operations/get_library_hubs_country/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `United States of America` + + diff --git a/content/types/operations/get_library_hubs_director/curl.mdx b/content/types/operations/get_library_hubs_director/curl.mdx new file mode 100644 index 0000000..33f3717 --- /dev/null +++ b/content/types/operations/get_library_hubs_director/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Nathan Greno` + + diff --git a/content/types/operations/get_library_hubs_genre/curl.mdx b/content/types/operations/get_library_hubs_genre/curl.mdx new file mode 100644 index 0000000..5abef66 --- /dev/null +++ b/content/types/operations/get_library_hubs_genre/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Animation` + + diff --git a/content/types/operations/get_library_hubs_hub/curl.mdx b/content/types/operations/get_library_hubs_hub/curl.mdx new file mode 100644 index 0000000..79fccf3 --- /dev/null +++ b/content/types/operations/get_library_hubs_hub/curl.mdx @@ -0,0 +1,61 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0` + +--- +##### `title` _string (optional)_ +
+**Example:** `Recently Played Movies` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `hubIdentifier` _string (optional)_ +
+**Example:** `movie.recentlyviewed.1` + +--- +##### `context` _string (optional)_ +
+**Example:** `hub.movie.recentlyviewed` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `6` + +--- +##### `more` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `style` _string (optional)_ +
+**Example:** `shelf` + +--- +##### `hubKey` _string (optional)_ +
+**Example:** `/library/metadata/66485,66098,57249,11449,5858,14944` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","skipCount":1,"studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}]` + +--- +##### `promoted` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `random` _boolean (optional)_ +
+**Example:** `true` + + diff --git a/content/types/operations/get_library_hubs_hubs_response_body/curl.mdx b/content/types/operations/get_library_hubs_hubs_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_library_hubs_hubs_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_library_hubs_media/curl.mdx b/content/types/operations/get_library_hubs_media/curl.mdx new file mode 100644 index 0000000..ea422e1 --- /dev/null +++ b/content/types/operations/get_library_hubs_media/curl.mdx @@ -0,0 +1,86 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `38247` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `6017237` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `2051` + +--- +##### `width` _integer (32-bit) (optional)_ +
+**Example:** `1920` + +--- +##### `height` _integer (32-bit) (optional)_ +
+**Example:** `1080` + +--- +##### `aspectRatio` _number (optional)_ +
+**Example:** `1.78` + +--- +##### `audioChannels` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `audioCodec` _string (optional)_ +
+**Example:** `aac` + +--- +##### `videoCodec` _string (optional)_ +
+**Example:** `h264` + +--- +##### `videoResolution` _string (optional)_ +
+**Example:** `1080` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `videoFrameRate` _string (optional)_ +
+**Example:** `24p` + +--- +##### `optimizedForStreaming` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + +--- +##### `part` _array (optional)_ +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}]` + + diff --git a/content/types/operations/get_library_hubs_media_container/curl.mdx b/content/types/operations/get_library_hubs_media_container/curl.mdx new file mode 100644 index 0000000..6c983b1 --- /dev/null +++ b/content/types/operations/get_library_hubs_media_container/curl.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `7` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionUUID` _string (optional)_ +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `hub` _array (optional)_ +
+**Example:** `[{"Metadata":[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Ceyda Torun"}],"Genre":[{"tag":"Documentary"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":4736174,"file":"/movies/Kedi (2017)/Kedi (2017) 1080p x264.mp4","has64bitOffsets":false,"id":129778,"key":"/library/parts/129778/1702586883/file.mp4","optimizedForStreaming":false,"size":1410810905,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2377,"container":"mp4","duration":4736174,"has64bitOffsets":false,"height":1080,"id":129531,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Bülent Üstün"}],"addedAt":1702586905,"art":"/library/metadata/66485/art/1702586907","audienceRating":8.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"Not Rated","duration":4736174,"guid":"plex://movie/5d776c3251dd69001fe38bb4","key":"/library/metadata/66485","lastViewedAt":1705786111,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2017-02-10T00:00:00Z","primaryExtraKey":"/library/metadata/66486","rating":9.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66485","studio":"Termite Films","summary":"A profile of an ancient city and its unique people, seen through the eyes of the most mysterious and beloved animal humans have ever known, the Cat.","tagline":"A cat meowing at your feet, looking up at you, is life smiling at you...","thumb":"/library/metadata/66485/thumb/1702586907","title":"Kedi","type":"movie","updatedAt":1702586907,"viewCount":2,"year":2017},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Duwayne Dunham"}],"Genre":[{"tag":"Adventure"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":5065775,"file":"/movies/Homeward Bound The Incredible Journey (1993)/Homeward Bound The Incredible Journey (1993) [BluRay] [1080p] [YTS.LT].mp4","has64bitOffsets":false,"id":129250,"key":"/library/parts/129250/1700434864/file.mp4","optimizedForStreaming":true,"size":1550855333,"videoProfile":"high"}],"aspectRatio":1.85,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2444,"container":"mp4","duration":5065775,"has64bitOffsets":false,"height":1024,"id":129003,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1904}],"Role":[{"tag":"Michael J. Fox"},{"tag":"Sally Field"},{"tag":"Don Ameche"}],"Writer":[{"tag":"Caroline Thompson"},{"tag":"Linda Woolverton"}],"addedAt":1700434925,"art":"/library/metadata/66098/art/1703148781","audienceRating":7.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"G","duration":5065775,"guid":"plex://movie/5d9f34f4adeb7a0021ce020f","key":"/library/metadata/66098","lastViewedAt":1705709811,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"1993-02-12T00:00:00Z","primaryExtraKey":"/library/metadata/66099","rating":8.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66098","studio":"Touchwood Pacific Partners 1","summary":"A fun-loving American bulldog pup, a hilarious Himalayan cat, and a wise old golden retriever embark on a long trek through the rugged wilderness of the Sierra Nevada mountains in a quest to reach home and their beloved owners.","tagline":"In the classic tradition of Walt Disney Pictures comes a story about courage, adventure and friendship.","thumb":"/library/metadata/66098/thumb/1703148781","title":"Homeward Bound: The Incredible Journey","type":"movie","updatedAt":1703148781,"viewCount":2,"year":1993},{"Country":[{"tag":"Canada"},{"tag":"Ireland"}],"Director":[{"tag":"Matt Stawski"}],"Genre":[{"tag":"Comedy"},{"tag":"Family"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mkv","duration":4459050,"file":"/movies/Blue's Big City Adventure (2022)/Blues.Big.City.Adventure.2022.2160p.4K.WEB.x265.10bit.AAC5.1-[YTS.MX].mkv","id":115478,"key":"/library/parts/115478/1669671340/file.mkv","size":3560750664,"videoProfile":"main 10"}],"aspectRatio":1.78,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":6384,"container":"mkv","duration":4459050,"height":2160,"id":115470,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Joshua Dela Cruz"},{"tag":"Steve Burns"},{"tag":"Donovan Patton"}],"Writer":[{"tag":"Traci Paige Johnson"},{"tag":"Todd Kessler"}],"addedAt":1669671356,"art":"/library/metadata/57249/art/1704274800","audienceRating":8.6,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"TV-Y","duration":4459050,"guid":"plex://movie/60eff7d3e22797002c55c1cc","key":"/library/metadata/57249","lastViewedAt":1705681955,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2022-11-18T00:00:00Z","primaryExtraKey":"/library/metadata/57250","rating":8.3,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"57249","skipCount":1,"studio":"Nickelodeon Movies","summary":"Josh and Blue skidoo to New York City to audition for Rainbow Puppy's Broadway musical, but they get lost when Josh accidentally left his Handy Dandy Notebook at home. This leads to a game of Blue's Clues to figure out where the audition is. Meanwhile, Tickety Tock and her friends go to New York City to find Josh and Blue and get to the audition with help from Joe and Steve.","tagline":"All They Need is You.","thumb":"/library/metadata/57249/thumb/1704274800","title":"Blue's Big City Adventure","type":"movie","updatedAt":1704274800,"viewCount":8,"year":2022},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Dan Scanlon"}],"Genre":[{"tag":"Animation"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"ma","container":"mkv","duration":6141428,"file":"/movies/Onward (2020)/Onward (2020) Bluray-1080p.mkv","id":29291,"key":"/library/parts/29291/1589237130/file.mkv","size":8426669232,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":8,"audioCodec":"dca-ma","audioProfile":"ma","bitrate":10977,"container":"mkv","duration":6141428,"height":804,"id":29291,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6142006,"file":"/movies/Onward (2020)/Onward (2020) WEBRip-1080p.mp4","has64bitOffsets":false,"id":29315,"key":"/library/parts/29315/1629002847/file.mp4","optimizedForStreaming":true,"size":2026154995,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2639,"container":"mp4","duration":6142006,"has64bitOffsets":false,"height":800,"id":29315,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Tom Holland"},{"tag":"Chris Pratt"},{"tag":"Julia Louis-Dreyfus"}],"Writer":[{"tag":"Kelsey Mann"},{"tag":"Dan Scanlon"}],"addedAt":1589237130,"art":"/library/metadata/11449/art/1705224000","audienceRating":9.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6141428,"guid":"plex://movie/5d776edfad5437001f803cf9","key":"/library/metadata/11449","lastViewedAt":1705543126,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2020-03-04T00:00:00Z","primaryExtraKey":"/library/metadata/11470","rating":8.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"11449","studio":"Walt Disney Pictures","summary":"In a magical world full of technological advances, elven brothers Ian and Barley Lightfoot set out on an adventure to resurrect their late father for a day.","tagline":"Their quest begineth.","thumb":"/library/metadata/11449/thumb/1705224000","title":"Onward","type":"movie","updatedAt":1705224000,"viewCount":3,"year":2020},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Chris Buck"},{"tag":"Jennifer Lee"}],"Genre":[{"tag":"Adventure"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6194042,"file":"/movies/Frozen II (2019)/Frozen II (2019) Bluray-1080p.mp4","has64bitOffsets":false,"id":14954,"key":"/library/parts/14954/1588207762/file.mp4","optimizedForStreaming":true,"size":1969230037,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2538,"container":"mp4","duration":6194042,"has64bitOffsets":false,"height":800,"id":14954,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6244271,"file":"/movies/Frozen II (2019)/Frozen II (2019) WEBRip-1080p.mp4","has64bitOffsets":false,"id":14999,"key":"/library/parts/14999/1629001526/file.mp4","optimizedForStreaming":true,"size":1983357282,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2536,"container":"mp4","duration":6244271,"has64bitOffsets":false,"height":800,"id":14999,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Idina Menzel"},{"tag":"Kristen Bell"},{"tag":"Josh Gad"}],"Writer":[{"tag":"Chris Buck"},{"tag":"Hans Christian Andersen"}],"addedAt":1588207762,"art":"/library/metadata/5858/art/1704621922","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6194042,"guid":"plex://movie/5d776b85594b2b001e6dc641","key":"/library/metadata/5858","lastViewedAt":1705337663,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2019-11-20T00:00:00Z","primaryExtraKey":"/library/metadata/5892","rating":7.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"5858","skipCount":1,"studio":"Walt Disney Pictures","summary":"Anna, Elsa, Kristoff, Olaf and Sven leave Arendelle to travel to an ancient, autumn-bound forest of an enchanted land. They set out to find the origin of Elsa's powers in order to save their kingdom.","tagline":"The past is not what it seems.","thumb":"/library/metadata/5858/thumb/1704621922","title":"Frozen II","type":"movie","updatedAt":1704621922,"viewCount":1,"year":2019},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}],"context":"hub.movie.recentlyviewed","hubIdentifier":"movie.recentlyviewed.1","hubKey":"/library/metadata/66485,66098,57249,11449,5858,14944","key":"/library/sections/1/all?sort=lastViewedAt:desc\u0026unwatched=0\u0026viewOffset=0","more":true,"promoted":true,"random":true,"size":6,"style":"shelf","title":"Recently Played Movies","type":"movie"}]` + + diff --git a/content/types/operations/get_library_hubs_metadata/curl.mdx b/content/types/operations/get_library_hubs_metadata/curl.mdx new file mode 100644 index 0000000..7a7e765 --- /dev/null +++ b/content/types/operations/get_library_hubs_metadata/curl.mdx @@ -0,0 +1,171 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `14944` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/14944` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://movie/5d77686eeb5d26001f1eb339` + +--- +##### `studio` _string (optional)_ +
+**Example:** `Walt Disney Animation Studios` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `title` _string (optional)_ +
+**Example:** `Tangled` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionKey` _string (optional)_ +
+**Example:** `/library/sections/1` + +--- +##### `contentRating` _string (optional)_ +
+**Example:** `PG` + +--- +##### `summary` _string (optional)_ +
+**Example:** `The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.` + +--- +##### `rating` _number (optional)_ +
+**Example:** `8.9` + +--- +##### `audienceRating` _number (optional)_ +
+**Example:** `8.7` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1704936047` + +--- +##### `year` _integer (32-bit) (optional)_ +
+**Example:** `2010` + +--- +##### `tagline` _string (optional)_ +
+**Example:** `They're taking adventure to new lengths.` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/14944/thumb/1705739847` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/14944/art/1705739847` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `6017237` + +--- +##### `originallyAvailableAt` _date (optional)_ +
+**Example:** `2010-11-24 00:00:00 +0000 UTC` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1589412494` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705739847` + +--- +##### `audienceRatingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `primaryExtraKey` _string (optional)_ +
+**Example:** `/library/metadata/14952` + +--- +##### `ratingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` _array (optional)_ +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + +--- +##### `genre` _array (optional)_ +
+**Example:** `[{"tag":"Animation"}]` + +--- +##### `country` _array (optional)_ +
+**Example:** `[{"tag":"United States of America"}]` + +--- +##### `director` _array (optional)_ +
+**Example:** `[{"tag":"Nathan Greno"}]` + +--- +##### `role` _array (optional)_ +
+**Example:** `[{"tag":"Donna Murphy"}]` + +--- +##### `writer` _array (optional)_ +
+**Example:** `[{"tag":"Wilhelm Grimm"}]` + +--- +##### `skipCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `chapterSource` _string (optional)_ +
+**Example:** `media` + + diff --git a/content/types/operations/get_library_hubs_part/curl.mdx b/content/types/operations/get_library_hubs_part/curl.mdx new file mode 100644 index 0000000..e2008e1 --- /dev/null +++ b/content/types/operations/get_library_hubs_part/curl.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `38247` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/parts/38247/1589412494/file.mp4` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `6017237` + +--- +##### `file` _string (optional)_ +
+**Example:** `/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1545647447` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `optimizedForStreaming` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + + diff --git a/content/types/operations/get_library_hubs_response/curl.mdx b/content/types/operations/get_library_hubs_response/curl.mdx index b206c58..6a730e2 100644 --- a/content/types/operations/get_library_hubs_response/curl.mdx +++ b/content/types/operations/get_library_hubs_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The hubs specific to the library import('/content/types/operations/get_library_hubs_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_library_hubs_hubs_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_library_hubs_response_body/curl.mdx b/content/types/operations/get_library_hubs_response_body/curl.mdx index 91839c7..deb7d2e 100644 --- a/content/types/operations/get_library_hubs_response_body/curl.mdx +++ b/content/types/operations/get_library_hubs_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_library_hubs_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_library_hubs_role/curl.mdx b/content/types/operations/get_library_hubs_role/curl.mdx new file mode 100644 index 0000000..a56468d --- /dev/null +++ b/content/types/operations/get_library_hubs_role/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Donna Murphy` + + diff --git a/content/types/operations/get_library_hubs_writer/curl.mdx b/content/types/operations/get_library_hubs_writer/curl.mdx new file mode 100644 index 0000000..fd86914 --- /dev/null +++ b/content/types/operations/get_library_hubs_writer/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Wilhelm Grimm` + + diff --git a/content/types/operations/get_library_items_country/curl.mdx b/content/types/operations/get_library_items_country/curl.mdx new file mode 100644 index 0000000..d45e2f2 --- /dev/null +++ b/content/types/operations/get_library_items_country/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `United States of America` + + diff --git a/content/types/operations/get_library_items_director/curl.mdx b/content/types/operations/get_library_items_director/curl.mdx new file mode 100644 index 0000000..dda2d63 --- /dev/null +++ b/content/types/operations/get_library_items_director/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `James Cameron` + + diff --git a/content/types/operations/get_library_items_errors/curl.mdx b/content/types/operations/get_library_items_errors/curl.mdx deleted file mode 100644 index be78074..0000000 --- a/content/types/operations/get_library_items_errors/curl.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `code` _number (optional)_ -
-**Example:** `1001` - ---- -##### `message` _string (optional)_ -
-**Example:** `User could not be authenticated` - ---- -##### `status` _number (optional)_ -
-**Example:** `401` - - diff --git a/content/types/operations/get_library_items_genre/curl.mdx b/content/types/operations/get_library_items_genre/curl.mdx new file mode 100644 index 0000000..f267ae2 --- /dev/null +++ b/content/types/operations/get_library_items_genre/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Adventure` + + diff --git a/content/types/operations/get_library_items_media/curl.mdx b/content/types/operations/get_library_items_media/curl.mdx new file mode 100644 index 0000000..2c2055e --- /dev/null +++ b/content/types/operations/get_library_items_media/curl.mdx @@ -0,0 +1,71 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `119534` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `11558112` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `25025` + +--- +##### `width` _integer (32-bit) (optional)_ +
+**Example:** `3840` + +--- +##### `height` _integer (32-bit) (optional)_ +
+**Example:** `2072` + +--- +##### `aspectRatio` _number (optional)_ +
+**Example:** `1.85` + +--- +##### `audioChannels` _integer (32-bit) (optional)_ +
+**Example:** `6` + +--- +##### `audioCodec` _string (optional)_ +
+**Example:** `eac3` + +--- +##### `videoCodec` _string (optional)_ +
+**Example:** `hevc` + +--- +##### `videoResolution` _string (optional)_ +
+**Example:** `4k` + +--- +##### `container` _string (optional)_ +
+**Example:** `mkv` + +--- +##### `videoFrameRate` _string (optional)_ +
+**Example:** `24p` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `main 10` + +--- +##### `part` _array (optional)_ +
+**Example:** `[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}]` + + diff --git a/content/types/operations/get_library_items_media_container/curl.mdx b/content/types/operations/get_library_items_media_container/curl.mdx new file mode 100644 index 0000000..55686b7 --- /dev/null +++ b/content/types/operations/get_library_items_media_container/curl.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `70` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `art` _string (optional)_ +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionUUID` _string (optional)_ +
+**Example:** `322a231a-b7f7-49f5-920f-14c61199cd30` + +--- +##### `mediaTagPrefix` _string (optional)_ +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion` _integer (32-bit) (optional)_ +
+**Example:** `1701731894` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `title2` _string (optional)_ +
+**Example:** `Recently Released` + +--- +##### `viewGroup` _string (optional)_ +
+**Example:** `movie` + +--- +##### `viewMode` _integer (32-bit) (optional)_ +
+**Example:** `65592` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` + + diff --git a/content/types/operations/get_library_items_metadata/curl.mdx b/content/types/operations/get_library_items_metadata/curl.mdx new file mode 100644 index 0000000..983f9bf --- /dev/null +++ b/content/types/operations/get_library_items_metadata/curl.mdx @@ -0,0 +1,171 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `58683` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/58683` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://movie/5d7768ba96b655001fdc0408` + +--- +##### `studio` _string (optional)_ +
+**Example:** `20th Century Studios` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `title` _string (optional)_ +
+**Example:** `Avatar: The Way of Water` + +--- +##### `contentRating` _string (optional)_ +
+**Example:** `PG-13` + +--- +##### `summary` _string (optional)_ +
+**Example:** `Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.` + +--- +##### `rating` _number (optional)_ +
+**Example:** `7.6` + +--- +##### `audienceRating` _number (optional)_ +
+**Example:** `9.2` + +--- +##### `year` _integer (32-bit) (optional)_ +
+**Example:** `2022` + +--- +##### `tagline` _string (optional)_ +
+**Example:** `Return to Pandora.` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/58683/thumb/1703239236` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/58683/art/1703239236` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `11558112` + +--- +##### `originallyAvailableAt` _date (optional)_ +
+**Example:** `2022-12-14 00:00:00 +0000 UTC` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1680457607` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1703239236` + +--- +##### `audienceRatingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `chapterSource` _string (optional)_ +
+**Example:** `media` + +--- +##### `primaryExtraKey` _string (optional)_ +
+**Example:** `/library/metadata/58684` + +--- +##### `ratingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` _array (optional)_ +
+**Example:** `[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}]` + +--- +##### `genre` _array (optional)_ +
+**Example:** `[{"tag":"Adventure"}]` + +--- +##### `country` _array (optional)_ +
+**Example:** `[{"tag":"United States of America"}]` + +--- +##### `director` _array (optional)_ +
+**Example:** `[{"tag":"James Cameron"}]` + +--- +##### `writer` _array (optional)_ +
+**Example:** `[{"tag":"James Cameron"}]` + +--- +##### `role` _array (optional)_ +
+**Example:** `[{"tag":"Sigourney Weaver"}]` + +--- +##### `titleSort` _string (optional)_ +
+**Example:** `Whale` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1682752242` + +--- +##### `originalTitle` _string (optional)_ +
+**Example:** `映画 ブラッククローバー 魔法帝の剣` + +--- +##### `viewOffset` _integer (32-bit) (optional)_ +
+**Example:** `5222500` + +--- +##### `skipCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + + diff --git a/content/types/operations/get_library_items_part/curl.mdx b/content/types/operations/get_library_items_part/curl.mdx new file mode 100644 index 0000000..d3f6bfb --- /dev/null +++ b/content/types/operations/get_library_items_part/curl.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `119542` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/parts/119542/1680457526/file.mkv` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `11558112` + +--- +##### `file` _string (optional)_ +
+**Example:** `/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv` + +--- +##### `size` _integer (optional)_ +
+**Example:** `36158371307` + +--- +##### `container` _string (optional)_ +
+**Example:** `mkv` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `main 10` + + diff --git a/content/types/operations/get_library_items_request/curl.mdx b/content/types/operations/get_library_items_request/curl.mdx index 5bce120..7e9ecf1 100644 --- a/content/types/operations/get_library_items_request/curl.mdx +++ b/content/types/operations/get_library_items_request/curl.mdx @@ -1,13 +1,15 @@ {/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ the Id of the library to query --- -##### `type` _number (optional)_ -item type +##### `tag` _enumeration_ +A key representing a specific tag within the section. + + import('/content/types/operations/tag/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> ---- -##### `filter` _string (optional)_ -the filter parameter diff --git a/content/types/operations/get_library_items_response/curl.mdx b/content/types/operations/get_library_items_response/curl.mdx index 72c3203..bc45ff8 100644 --- a/content/types/operations/get_library_items_response/curl.mdx +++ b/content/types/operations/get_library_items_response/curl.mdx @@ -15,7 +15,7 @@ Raw HTTP response; suitable for custom response parsing --- ##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +The contents of the library by section and tag import('/content/types/operations/get_library_items_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/operations/get_library_items_response_body/curl.mdx b/content/types/operations/get_library_items_response_body/curl.mdx index 91839c7..1e63158 100644 --- a/content/types/operations/get_library_items_response_body/curl.mdx +++ b/content/types/operations/get_library_items_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_library_items_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_library_items_role/curl.mdx b/content/types/operations/get_library_items_role/curl.mdx new file mode 100644 index 0000000..22c1e30 --- /dev/null +++ b/content/types/operations/get_library_items_role/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Sigourney Weaver` + + diff --git a/content/types/operations/get_library_items_writer/curl.mdx b/content/types/operations/get_library_items_writer/curl.mdx new file mode 100644 index 0000000..dda2d63 --- /dev/null +++ b/content/types/operations/get_library_items_writer/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `James Cameron` + + diff --git a/content/types/operations/get_library_library_response_body/curl.mdx b/content/types/operations/get_library_library_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_library_library_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_library_media_container/curl.mdx b/content/types/operations/get_library_media_container/curl.mdx new file mode 100644 index 0000000..d40beca --- /dev/null +++ b/content/types/operations/get_library_media_container/curl.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `29` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `art` _string (optional)_ +
+**Example:** `/:/resources/movie-fanart.jpg` + +--- +##### `content` _string (optional)_ +
+**Example:** `secondary` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `mediaTagPrefix` _string (optional)_ +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion` _integer (32-bit) (optional)_ +
+**Example:** `1701731894` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/:/resources/movie.png` + +--- +##### `title1` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `viewGroup` _string (optional)_ +
+**Example:** `secondary` + +--- +##### `viewMode` _integer (32-bit) (optional)_ +
+**Example:** `65592` + +--- +##### `directory` _array (optional)_ +
+**Example:** `[{"key":"search?type=1","prompt":"Search Movies","search":true,"secondary":true,"title":"Search..."}]` + +--- +##### `type` _array (optional)_ +
+**Example:** `[{"Field":[{"key":"title","title":"Title","type":"string"},{"key":"studio","title":"Studio","type":"string"},{"key":"userRating","subType":"rating","title":"Rating","type":"integer"},{"key":"contentRating","title":"Content Rating","type":"tag"},{"key":"year","subType":"year","title":"Year","type":"integer"},{"key":"decade","subType":"decade","title":"Decade","type":"integer"},{"key":"originallyAvailableAt","title":"Release Date","type":"date"},{"key":"duration","subType":"duration","title":"Duration","type":"integer"},{"key":"unmatched","title":"Unmatched","type":"boolean"},{"key":"duplicate","title":"Duplicate","type":"boolean"},{"key":"genre","title":"Genre","type":"tag"},{"key":"collection","title":"Collection","type":"tag"},{"key":"director","title":"Director","type":"tag"},{"key":"writer","title":"Writer","type":"tag"},{"key":"producer","title":"Producer","type":"tag"},{"key":"actor","title":"Actor","type":"tag"},{"key":"country","title":"Country","type":"tag"},{"key":"addedAt","title":"Date Added","type":"date"},{"key":"viewCount","title":"Plays","type":"integer"},{"key":"lastViewedAt","title":"Last Played","type":"date"},{"key":"unwatched","title":"Unplayed","type":"boolean"},{"key":"resolution","title":"Resolution","type":"resolution"},{"key":"hdr","subType":"hdr","title":"HDR","type":"boolean"},{"key":"mediaSize","subType":"fileSize","title":"File Size","type":"integer"},{"key":"mediaBitrate","subType":"bitrate","title":"Bitrate","type":"integer"},{"key":"subtitleLanguage","title":"Subtitle Language","type":"subtitleLanguage"},{"key":"audioLanguage","title":"Audio Language","type":"audioLanguage"},{"key":"inProgress","title":"In Progress","type":"boolean"},{"key":"trash","title":"Trash","type":"boolean"},{"key":"editionTitle","title":"Edition","type":"string"},{"key":"label","title":"Label","type":"tag"}],"Filter":[{"filter":"genre","filterType":"string","key":"/library/sections/1/genre","title":"Genre","type":"filter"},{"filter":"year","filterType":"integer","key":"/library/sections/1/year","title":"Year","type":"filter"},{"filter":"decade","filterType":"integer","key":"/library/sections/1/decade","title":"Decade","type":"filter"},{"filter":"contentRating","filterType":"string","key":"/library/sections/1/contentRating","title":"Content Rating","type":"filter"},{"filter":"collection","filterType":"string","key":"/library/sections/1/collection","title":"Collection","type":"filter"},{"filter":"director","filterType":"string","key":"/library/sections/1/director","title":"Director","type":"filter"},{"filter":"actor","filterType":"string","key":"/library/sections/1/actor","title":"Actor","type":"filter"},{"filter":"writer","filterType":"string","key":"/library/sections/1/writer","title":"Writer","type":"filter"},{"filter":"producer","filterType":"string","key":"/library/sections/1/producer","title":"Producer","type":"filter"},{"filter":"country","filterType":"string","key":"/library/sections/1/country","title":"Country","type":"filter"},{"filter":"studio","filterType":"string","key":"/library/sections/1/studio","title":"Studio","type":"filter"},{"filter":"resolution","filterType":"string","key":"/library/sections/1/resolution","title":"Resolution","type":"filter"},{"filter":"hdr","filterType":"boolean","key":"/library/sections/1/hdr","title":"HDR","type":"filter"},{"filter":"unwatched","filterType":"boolean","key":"/library/sections/1/unwatched","title":"Unplayed","type":"filter"},{"filter":"inProgress","filterType":"boolean","key":"/library/sections/1/inProgress","title":"In Progress","type":"filter"},{"filter":"unmatched","filterType":"boolean","key":"/library/sections/1/unmatched","title":"Unmatched","type":"filter"},{"filter":"audioLanguage","filterType":"string","key":"/library/sections/1/audioLanguage","title":"Audio Language","type":"filter"},{"filter":"subtitleLanguage","filterType":"string","key":"/library/sections/1/subtitleLanguage","title":"Subtitle Language","type":"filter"},{"filter":"editionTitle","filterType":"string","key":"/library/sections/1/editionTitle","title":"Edition","type":"filter"},{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}],"Sort":[{"default":"asc","defaultDirection":"asc","descKey":"titleSort:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"titleSort","title":"Title"},{"defaultDirection":"desc","descKey":"originallyAvailableAt:desc","key":"originallyAvailableAt","title":"Release Date"},{"defaultDirection":"desc","descKey":"rating:desc","key":"rating","title":"Critic Rating"},{"defaultDirection":"desc","descKey":"audienceRating:desc","key":"audienceRating","title":"Audience Rating"},{"defaultDirection":"desc","descKey":"duration:desc","key":"duration","title":"Duration"},{"defaultDirection":"desc","descKey":"addedAt:desc","key":"addedAt","title":"Date Added"},{"defaultDirection":"desc","descKey":"lastViewedAt:desc","key":"lastViewedAt","title":"Date Viewed"},{"defaultDirection":"asc","descKey":"mediaHeight:desc","key":"mediaHeight","title":"Resolution"},{"defaultDirection":"desc","descKey":"random:desc","key":"random","title":"Randomly"}],"active":false,"key":"/library/sections/1/all?type=1","title":"Movies","type":"movie"}]` + +--- +##### `fieldType` _array (optional)_ +
+**Example:** `[{"Operator":[{"key":"=","title":"is"}],"type":"resolution"}]` + + diff --git a/content/types/operations/get_library_response/curl.mdx b/content/types/operations/get_library_response/curl.mdx index 56905fb..067877b 100644 --- a/content/types/operations/get_library_response/curl.mdx +++ b/content/types/operations/get_library_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The details of the library import('/content/types/operations/get_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_library_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_library_response_body/curl.mdx b/content/types/operations/get_library_response_body/curl.mdx index 91839c7..6cda7ae 100644 --- a/content/types/operations/get_library_response_body/curl.mdx +++ b/content/types/operations/get_library_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_library_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_library_type/curl.mdx b/content/types/operations/get_library_type/curl.mdx new file mode 100644 index 0000000..ffcdc50 --- /dev/null +++ b/content/types/operations/get_library_type/curl.mdx @@ -0,0 +1,36 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `/library/sections/1/all?type=1` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `title` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `active` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `filter` _array (optional)_ +
+**Example:** `[{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}]` + +--- +##### `sort` _array (optional)_ +
+**Example:** `[{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}]` + +--- +##### `field` _array (optional)_ +
+**Example:** `[{"key":"label","subType":"bitrate","title":"Label","type":"tag"}]` + + diff --git a/content/types/operations/get_metadata_children_directory/curl.mdx b/content/types/operations/get_metadata_children_directory/curl.mdx new file mode 100644 index 0000000..3b1cd44 --- /dev/null +++ b/content/types/operations/get_metadata_children_directory/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `16` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `viewedLeafCount` _integer (32-bit) (optional)_ +
+**Example:** `16` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/30072/allLeaves` + +--- +##### `title` _string (optional)_ +
+**Example:** `All episodes` + + diff --git a/content/types/operations/get_metadata_children_library_response_body/curl.mdx b/content/types/operations/get_metadata_children_library_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_metadata_children_library_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_metadata_children_media_container/curl.mdx b/content/types/operations/get_metadata_children_media_container/curl.mdx new file mode 100644 index 0000000..1638cdd --- /dev/null +++ b/content/types/operations/get_metadata_children_media_container/curl.mdx @@ -0,0 +1,116 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `3` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `key` _string (optional)_ +
+**Example:** `30072` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `TV Shows` + +--- +##### `librarySectionUUID` _string (optional)_ +
+**Example:** `4bb2521c-8ba9-459b-aaee-8ab8bc35eabd` + +--- +##### `mediaTagPrefix` _string (optional)_ +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion` _integer (32-bit) (optional)_ +
+**Example:** `1701731894` + +--- +##### `nocache` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentTitle` _string (optional)_ +
+**Example:** `Reacher` + +--- +##### `parentYear` _integer (32-bit) (optional)_ +
+**Example:** `2022` + +--- +##### `summary` _string (optional)_ +
+**Example:** `When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.` + +--- +##### `theme` _string (optional)_ +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `title1` _string (optional)_ +
+**Example:** `TV Shows` + +--- +##### `title2` _string (optional)_ +
+**Example:** `Reacher` + +--- +##### `viewGroup` _string (optional)_ +
+**Example:** `season` + +--- +##### `viewMode` _integer (32-bit) (optional)_ +
+**Example:** `65593` + +--- +##### `directory` _array (optional)_ +
+**Example:** `[{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}]` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}]` + + diff --git a/content/types/operations/get_metadata_children_metadata/curl.mdx b/content/types/operations/get_metadata_children_metadata/curl.mdx new file mode 100644 index 0000000..e211152 --- /dev/null +++ b/content/types/operations/get_metadata_children_metadata/curl.mdx @@ -0,0 +1,136 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `66488` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/66488/children` + +--- +##### `parentRatingKey` _string (optional)_ +
+**Example:** `30072` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://season/652aea6549508477c34c6000` + +--- +##### `parentGuid` _string (optional)_ +
+**Example:** `plex://show/5d9c09190aaccd001f8f42f0` + +--- +##### `parentStudio` _string (optional)_ +
+**Example:** `Amazon Studios` + +--- +##### `type` _string (optional)_ +
+**Example:** `season` + +--- +##### `title` _string (optional)_ +
+**Example:** `Season 2` + +--- +##### `parentKey` _string (optional)_ +
+**Example:** `/library/metadata/30072` + +--- +##### `parentTitle` _string (optional)_ +
+**Example:** `Reacher` + +--- +##### `summary` _string (optional)_ +
+**Example:** `Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.` + +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `11` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705646565` + +--- +##### `parentYear` _integer (32-bit) (optional)_ +
+**Example:** `2022` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/66488/thumb/1703065033` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/30072/art/1705739923` + +--- +##### `parentThumb` _string (optional)_ +
+**Example:** `/library/metadata/30072/thumb/1705739923` + +--- +##### `parentTheme` _string (optional)_ +
+**Example:** `/library/metadata/30072/theme/1705739923` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `8` + +--- +##### `viewedLeafCount` _integer (32-bit) (optional)_ +
+**Example:** `8` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1702602021` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1703065033` + +--- +##### `userRating` _integer (32-bit) (optional)_ +
+**Example:** `9` + +--- +##### `skipCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `lastRatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1703881224` + + diff --git a/content/types/operations/get_metadata_children_response/curl.mdx b/content/types/operations/get_metadata_children_response/curl.mdx index 1ffaa19..8d6b533 100644 --- a/content/types/operations/get_metadata_children_response/curl.mdx +++ b/content/types/operations/get_metadata_children_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The children of the library item. import('/content/types/operations/get_metadata_children_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_metadata_children_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_metadata_children_response_body/curl.mdx b/content/types/operations/get_metadata_children_response_body/curl.mdx index 91839c7..55fb67f 100644 --- a/content/types/operations/get_metadata_children_response_body/curl.mdx +++ b/content/types/operations/get_metadata_children_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_metadata_children_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_metadata_country/curl.mdx b/content/types/operations/get_metadata_country/curl.mdx new file mode 100644 index 0000000..155b69e --- /dev/null +++ b/content/types/operations/get_metadata_country/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `116` + +--- +##### `filter` _string (optional)_ +
+**Example:** `country=116` + +--- +##### `tag` _string (optional)_ +
+**Example:** `United States of America` + + diff --git a/content/types/operations/get_metadata_director/curl.mdx b/content/types/operations/get_metadata_director/curl.mdx new file mode 100644 index 0000000..1eb1c63 --- /dev/null +++ b/content/types/operations/get_metadata_director/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `130` + +--- +##### `filter` _string (optional)_ +
+**Example:** `director=130` + +--- +##### `tag` _string (optional)_ +
+**Example:** `Joss Whedon` + +--- +##### `tagKey` _string (optional)_ +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/operations/get_metadata_genre/curl.mdx b/content/types/operations/get_metadata_genre/curl.mdx new file mode 100644 index 0000000..d466953 --- /dev/null +++ b/content/types/operations/get_metadata_genre/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `184` + +--- +##### `filter` _string (optional)_ +
+**Example:** `genre=184` + +--- +##### `tag` _string (optional)_ +
+**Example:** `Thriller` + + diff --git a/content/types/operations/get_metadata_library_response_body/curl.mdx b/content/types/operations/get_metadata_library_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_metadata_library_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_metadata_media/curl.mdx b/content/types/operations/get_metadata_media/curl.mdx new file mode 100644 index 0000000..b5c11b4 --- /dev/null +++ b/content/types/operations/get_metadata_media/curl.mdx @@ -0,0 +1,86 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `15` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141417` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `2278` + +--- +##### `width` _integer (32-bit) (optional)_ +
+**Example:** `1920` + +--- +##### `height` _integer (32-bit) (optional)_ +
+**Example:** `814` + +--- +##### `aspectRatio` _number (optional)_ +
+**Example:** `2.35` + +--- +##### `audioChannels` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `audioCodec` _string (optional)_ +
+**Example:** `aac` + +--- +##### `videoCodec` _string (optional)_ +
+**Example:** `h264` + +--- +##### `videoResolution` _string (optional)_ +
+**Example:** `1080` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `videoFrameRate` _string (optional)_ +
+**Example:** `24p` + +--- +##### `optimizedForStreaming` _integer (32-bit) (optional)_ +
+**Example:** `0` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + +--- +##### `part` _array (optional)_ +
+**Example:** `[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + diff --git a/content/types/operations/get_metadata_media_container/curl.mdx b/content/types/operations/get_metadata_media_container/curl.mdx new file mode 100644 index 0000000..1e78cd0 --- /dev/null +++ b/content/types/operations/get_metadata_media_container/curl.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionUUID` _string (optional)_ +
+**Example:** `cfc899d7-3000-46f6-8489-b9592714ada5` + +--- +##### `mediaTagPrefix` _string (optional)_ +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion` _integer (32-bit) (optional)_ +
+**Example:** `1698860922` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"Country":[{"filter":"country=116","id":116,"tag":"United States of America"}],"Director":[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"Genre":[{"filter":"genre=5","id":5,"tag":"Science Fiction"}],"Guid":[{"id":"imdb://tt0379786"}],"Media":[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Producer":[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}],"Rating":[{"image":"imdb://image.rating","type":"audience","value":7.8}],"Role":[{"filter":"actor=8","id":8,"role":"Malcolm \"Mal\" Reynolds","tag":"Nathan Fillion","tagKey":"5d7768286f4521001ea9945c","thumb":"https://metadata-static.plex.tv/4/people/4a2890ca346eb832500b1ed0add89d5e.jpg"}],"Writer":[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141417,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","type":"movie","updatedAt":1705637165,"year":2005}]` + + diff --git a/content/types/operations/get_metadata_metadata/curl.mdx b/content/types/operations/get_metadata_metadata/curl.mdx new file mode 100644 index 0000000..184500b --- /dev/null +++ b/content/types/operations/get_metadata_metadata/curl.mdx @@ -0,0 +1,166 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `17` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/17` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio` _string (optional)_ +
+**Example:** `Universal Pictures` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `title` _string (optional)_ +
+**Example:** `Serenity` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionKey` _string (optional)_ +
+**Example:** `/library/sections/1` + +--- +##### `contentRating` _string (optional)_ +
+**Example:** `PG-13` + +--- +##### `summary` _string (optional)_ +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating` _number (optional)_ +
+**Example:** `8.2` + +--- +##### `audienceRating` _number (optional)_ +
+**Example:** `9.1` + +--- +##### `year` _integer (32-bit) (optional)_ +
+**Example:** `2005` + +--- +##### `tagline` _string (optional)_ +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141417` + +--- +##### `originallyAvailableAt` _date (optional)_ +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705637164` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705637165` + +--- +##### `audienceRatingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `hasPremiumPrimaryExtra` _string (optional)_ +
+**Example:** `1` + +--- +##### `ratingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` _array (optional)_ +
+**Example:** `[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + +--- +##### `genre` _array (optional)_ +
+**Example:** `[{"filter":"genre=184","id":184,"tag":"Thriller"}]` + +--- +##### `country` _array (optional)_ +
+**Example:** `[{"filter":"country=116","id":116,"tag":"United States of America"}]` + +--- +##### `guids` _array (optional)_ +
+**Example:** `[{"id":"tvdb://2337"}]` + +--- +##### `ratings` _array (optional)_ +
+**Example:** `[{"image":"themoviedb://image.rating","type":"audience","value":7.4}]` + +--- +##### `director` _array (optional)_ +
+**Example:** `[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + +--- +##### `writer` _array (optional)_ +
+**Example:** `[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` + +--- +##### `role` _array (optional)_ +
+**Example:** `[{"filter":"actor=220","id":220,"role":"Bar Guy (uncredited)","tag":"Dennis Keiffer","tagKey":"5d77683554f42c001f8c4708","thumb":"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"}]` + +--- +##### `producer` _array (optional)_ +
+**Example:** `[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}]` + + diff --git a/content/types/operations/get_metadata_part/curl.mdx b/content/types/operations/get_metadata_part/curl.mdx new file mode 100644 index 0000000..6803980 --- /dev/null +++ b/content/types/operations/get_metadata_part/curl.mdx @@ -0,0 +1,56 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `15` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141417` + +--- +##### `file` _string (optional)_ +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `40271948` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `optimizedForStreaming` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + +--- +##### `stream` _array (optional)_ +
+**Example:** `[{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}]` + + diff --git a/content/types/operations/get_metadata_response/curl.mdx b/content/types/operations/get_metadata_response/curl.mdx index 08699bc..0cd6736 100644 --- a/content/types/operations/get_metadata_response/curl.mdx +++ b/content/types/operations/get_metadata_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The metadata of the library item. import('/content/types/operations/get_metadata_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_metadata_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_metadata_response_body/curl.mdx b/content/types/operations/get_metadata_response_body/curl.mdx index 91839c7..16ae76f 100644 --- a/content/types/operations/get_metadata_response_body/curl.mdx +++ b/content/types/operations/get_metadata_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_metadata_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_metadata_role/curl.mdx b/content/types/operations/get_metadata_role/curl.mdx new file mode 100644 index 0000000..5ea6141 --- /dev/null +++ b/content/types/operations/get_metadata_role/curl.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `220` + +--- +##### `filter` _string (optional)_ +
+**Example:** `actor=220` + +--- +##### `tag` _string (optional)_ +
+**Example:** `Dennis Keiffer` + +--- +##### `tagKey` _string (optional)_ +
+**Example:** `5d77683554f42c001f8c4708` + +--- +##### `role` _string (optional)_ +
+**Example:** `Bar Guy (uncredited)` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg` + + diff --git a/content/types/operations/get_metadata_writer/curl.mdx b/content/types/operations/get_metadata_writer/curl.mdx new file mode 100644 index 0000000..d2924df --- /dev/null +++ b/content/types/operations/get_metadata_writer/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `132` + +--- +##### `filter` _string (optional)_ +
+**Example:** `writer=132` + +--- +##### `tag` _string (optional)_ +
+**Example:** `Joss Whedon` + +--- +##### `tagKey` _string (optional)_ +
+**Example:** `5d776828880197001ec90e8f` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg` + + diff --git a/content/types/operations/get_on_deck_guids/curl.mdx b/content/types/operations/get_on_deck_guids/curl.mdx new file mode 100644 index 0000000..2b9520a --- /dev/null +++ b/content/types/operations/get_on_deck_guids/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _string (optional)_ +
+**Example:** `imdb://tt13303712` + + diff --git a/content/types/operations/get_on_deck_stream/curl.mdx b/content/types/operations/get_on_deck_stream/curl.mdx new file mode 100644 index 0000000..3c29888 --- /dev/null +++ b/content/types/operations/get_on_deck_stream/curl.mdx @@ -0,0 +1,114 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _number (optional)_ +
+**Example:** `211234` + +--- +##### `streamType` _number (optional)_ +
+**Example:** `1` + +--- +##### `default` _boolean (optional)_ + +--- +##### `codec` _string (optional)_ +
+**Example:** `hevc` + +--- +##### `index` _number (optional)_ +
+**Example:** `0` + +--- +##### `bitrate` _number (optional)_ +
+**Example:** `918` + +--- +##### `language` _string (optional)_ +
+**Example:** `English` + +--- +##### `languageTag` _string (optional)_ +
+**Example:** `en` + +--- +##### `languageCode` _string (optional)_ +
+**Example:** `eng` + +--- +##### `bitDepth` _number (optional)_ +
+**Example:** `8` + +--- +##### `chromaLocation` _string (optional)_ +
+**Example:** `left` + +--- +##### `chromaSubsampling` _string (optional)_ +
+**Example:** `4:2:0` + +--- +##### `codedHeight` _number (optional)_ +
+**Example:** `1080` + +--- +##### `codedWidth` _number (optional)_ +
+**Example:** `1920` + +--- +##### `colorRange` _string (optional)_ +
+**Example:** `tv` + +--- +##### `frameRate` _number (optional)_ +
+**Example:** `25` + +--- +##### `height` _number (optional)_ +
+**Example:** `1080` + +--- +##### `level` _number (optional)_ +
+**Example:** `120` + +--- +##### `profile` _string (optional)_ +
+**Example:** `main` + +--- +##### `refFrames` _number (optional)_ +
+**Example:** `1` + +--- +##### `width` _number (optional)_ +
+**Example:** `1920` + +--- +##### `displayTitle` _string (optional)_ +
+**Example:** `1080p (HEVC Main)` + +--- +##### `extendedDisplayTitle` _string (optional)_ +
+**Example:** `1080p (HEVC Main)` + + diff --git a/content/types/operations/get_playlist_contents_country/curl.mdx b/content/types/operations/get_playlist_contents_country/curl.mdx new file mode 100644 index 0000000..d45e2f2 --- /dev/null +++ b/content/types/operations/get_playlist_contents_country/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `United States of America` + + diff --git a/content/types/operations/get_playlist_contents_director/curl.mdx b/content/types/operations/get_playlist_contents_director/curl.mdx new file mode 100644 index 0000000..6b9e0ef --- /dev/null +++ b/content/types/operations/get_playlist_contents_director/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Joss Whedon` + + diff --git a/content/types/operations/get_playlist_contents_genre/curl.mdx b/content/types/operations/get_playlist_contents_genre/curl.mdx new file mode 100644 index 0000000..3132bd9 --- /dev/null +++ b/content/types/operations/get_playlist_contents_genre/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Action` + + diff --git a/content/types/operations/get_playlist_contents_media/curl.mdx b/content/types/operations/get_playlist_contents_media/curl.mdx new file mode 100644 index 0000000..a4e3b42 --- /dev/null +++ b/content/types/operations/get_playlist_contents_media/curl.mdx @@ -0,0 +1,86 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `15` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141416` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `2273` + +--- +##### `width` _integer (32-bit) (optional)_ +
+**Example:** `1920` + +--- +##### `height` _integer (32-bit) (optional)_ +
+**Example:** `814` + +--- +##### `aspectRatio` _number (optional)_ +
+**Example:** `2.35` + +--- +##### `audioChannels` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `audioCodec` _string (optional)_ +
+**Example:** `aac` + +--- +##### `videoCodec` _string (optional)_ +
+**Example:** `h264` + +--- +##### `videoResolution` _string (optional)_ +
+**Example:** `1080` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `videoFrameRate` _string (optional)_ +
+**Example:** `24p` + +--- +##### `optimizedForStreaming` _integer (32-bit) (optional)_ +
+**Example:** `0` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + +--- +##### `part` _array (optional)_ +
+**Example:** `[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` + + diff --git a/content/types/operations/get_playlist_contents_media_container/curl.mdx b/content/types/operations/get_playlist_contents_media_container/curl.mdx new file mode 100644 index 0000000..3f17f3a --- /dev/null +++ b/content/types/operations/get_playlist_contents_media_container/curl.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/95/composite/1705717521` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `282` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `ratingKey` _string (optional)_ +
+**Example:** `95` + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `title` _string (optional)_ +
+**Example:** `Smart Movie Playlist` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Joss Whedon"}],"Genre":[{"tag":"Science Fiction"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Nathan Fillion"}],"Writer":[{"tag":"Joss Whedon"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141416,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","titleSort":"Amazing Spider-Man 2","type":"movie","updatedAt":1705637165,"year":2005}]` + + diff --git a/content/types/operations/get_playlist_contents_metadata/curl.mdx b/content/types/operations/get_playlist_contents_metadata/curl.mdx new file mode 100644 index 0000000..537b86d --- /dev/null +++ b/content/types/operations/get_playlist_contents_metadata/curl.mdx @@ -0,0 +1,161 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `17` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/17` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://movie/5d77683f6f4521001ea9dc53` + +--- +##### `studio` _string (optional)_ +
+**Example:** `Universal Pictures` + +--- +##### `type` _string (optional)_ +
+**Example:** `movie` + +--- +##### `title` _string (optional)_ +
+**Example:** `Serenity` + +--- +##### `titleSort` _string (optional)_ +
+**Example:** `Amazing Spider-Man 2` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Movies` + +--- +##### `librarySectionID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `librarySectionKey` _string (optional)_ +
+**Example:** `/library/sections/1` + +--- +##### `contentRating` _string (optional)_ +
+**Example:** `PG-13` + +--- +##### `summary` _string (optional)_ +
+**Example:** `Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.` + +--- +##### `rating` _number (optional)_ +
+**Example:** `8.2` + +--- +##### `audienceRating` _number (optional)_ +
+**Example:** `9.1` + +--- +##### `year` _integer (32-bit) (optional)_ +
+**Example:** `2005` + +--- +##### `tagline` _string (optional)_ +
+**Example:** `They aim to misbehave.` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/17/thumb/1705637165` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/17/art/1705637165` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141416` + +--- +##### `originallyAvailableAt` _date (optional)_ +
+**Example:** `2005-09-29 00:00:00 +0000 UTC` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705637164` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705637165` + +--- +##### `audienceRatingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.upright` + +--- +##### `hasPremiumExtras` _string (optional)_ +
+**Example:** `1` + +--- +##### `hasPremiumPrimaryExtra` _string (optional)_ +
+**Example:** `1` + +--- +##### `ratingImage` _string (optional)_ +
+**Example:** `rottentomatoes://image.rating.ripe` + +--- +##### `media` _array (optional)_ +
+**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` + +--- +##### `genre` _array (optional)_ +
+**Example:** `[{"tag":"Action"}]` + +--- +##### `country` _array (optional)_ +
+**Example:** `[{"tag":"United States of America"}]` + +--- +##### `director` _array (optional)_ +
+**Example:** `[{"tag":"Joss Whedon"}]` + +--- +##### `writer` _array (optional)_ +
+**Example:** `[{"tag":"Joss Whedon"}]` + +--- +##### `role` _array (optional)_ +
+**Example:** `[{"tag":"Gina Torres"}]` + + diff --git a/content/types/operations/get_playlist_contents_part/curl.mdx b/content/types/operations/get_playlist_contents_part/curl.mdx new file mode 100644 index 0000000..d95842d --- /dev/null +++ b/content/types/operations/get_playlist_contents_part/curl.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `15` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/parts/15/1705637151/file.mp4` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `141416` + +--- +##### `file` _string (optional)_ +
+**Example:** `/movies/Serenity (2005)/Serenity (2005).mp4` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `40271948` + +--- +##### `audioProfile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `container` _string (optional)_ +
+**Example:** `mp4` + +--- +##### `has64bitOffsets` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `optimizedForStreaming` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `videoProfile` _string (optional)_ +
+**Example:** `high` + + diff --git a/content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx b/content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_playlist_contents_response/curl.mdx b/content/types/operations/get_playlist_contents_response/curl.mdx index 0103fd5..a509dd4 100644 --- a/content/types/operations/get_playlist_contents_response/curl.mdx +++ b/content/types/operations/get_playlist_contents_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The playlist contents import('/content/types/operations/get_playlist_contents_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_playlist_contents_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_playlist_contents_response_body/curl.mdx b/content/types/operations/get_playlist_contents_response_body/curl.mdx index 91839c7..fd79b95 100644 --- a/content/types/operations/get_playlist_contents_response_body/curl.mdx +++ b/content/types/operations/get_playlist_contents_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_playlist_contents_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_playlist_contents_role/curl.mdx b/content/types/operations/get_playlist_contents_role/curl.mdx new file mode 100644 index 0000000..41dafaf --- /dev/null +++ b/content/types/operations/get_playlist_contents_role/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Gina Torres` + + diff --git a/content/types/operations/get_playlist_contents_writer/curl.mdx b/content/types/operations/get_playlist_contents_writer/curl.mdx new file mode 100644 index 0000000..6b9e0ef --- /dev/null +++ b/content/types/operations/get_playlist_contents_writer/curl.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `tag` _string (optional)_ +
+**Example:** `Joss Whedon` + + diff --git a/content/types/operations/get_playlist_media_container/curl.mdx b/content/types/operations/get_playlist_media_container/curl.mdx new file mode 100644 index 0000000..9b14c2c --- /dev/null +++ b/content/types/operations/get_playlist_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}]` + + diff --git a/content/types/operations/get_playlist_metadata/curl.mdx b/content/types/operations/get_playlist_metadata/curl.mdx new file mode 100644 index 0000000..eb0dd18 --- /dev/null +++ b/content/types/operations/get_playlist_metadata/curl.mdx @@ -0,0 +1,74 @@ +{/* Autogenerated DO NOT EDIT */} +##### `content` _string (optional)_ +
+**Example:** `library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1` + +--- +##### `ratingKey` _string (optional)_ +
+**Example:** `95` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/95/items` + +--- +##### `guid` _string (optional)_ +
+**Example:** `com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `title` _string (optional)_ +
+**Example:** `Smart Movie Playlist` + +--- +##### `summary` _string (optional)_ + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/95/composite/1705717387` + +--- +##### `icon` _string (optional)_ +
+**Example:** `playlist://image.smart` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `282000` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705716493` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705717387` + + diff --git a/content/types/operations/get_playlist_playlists_response_body/curl.mdx b/content/types/operations/get_playlist_playlists_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_playlist_playlists_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_playlist_response/curl.mdx b/content/types/operations/get_playlist_response/curl.mdx index 480f07d..8395fc0 100644 --- a/content/types/operations/get_playlist_response/curl.mdx +++ b/content/types/operations/get_playlist_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The playlist import('/content/types/operations/get_playlist_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_playlist_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_playlist_response_body/curl.mdx b/content/types/operations/get_playlist_response_body/curl.mdx index 91839c7..c70d9ac 100644 --- a/content/types/operations/get_playlist_response_body/curl.mdx +++ b/content/types/operations/get_playlist_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_playlist_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_playlists_media_container/curl.mdx b/content/types/operations/get_playlists_media_container/curl.mdx new file mode 100644 index 0000000..76b326c --- /dev/null +++ b/content/types/operations/get_playlists_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `4` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1705716298,"composite":"/playlists/92/composite/1705716440","duration":7328000,"guid":"com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903","icon":"playlist://image.smart","key":"/playlists/92/items","lastViewedAt":1705716298,"leafCount":32,"playlistType":"video","ratingKey":"92","smart":false,"summary":"A Great Playlist","title":"Static Playlist","type":"playlist","updatedAt":1705716440,"viewCount":1}]` + + diff --git a/content/types/operations/get_playlists_metadata/curl.mdx b/content/types/operations/get_playlists_metadata/curl.mdx new file mode 100644 index 0000000..ded6fd4 --- /dev/null +++ b/content/types/operations/get_playlists_metadata/curl.mdx @@ -0,0 +1,81 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `92` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/92/items` + +--- +##### `guid` _string (optional)_ +
+**Example:** `com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `title` _string (optional)_ +
+**Example:** `Static Playlist` + +--- +##### `summary` _string (optional)_ +
+**Example:** `A Great Playlist` + +--- +##### `smart` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `playlistType` _string (optional)_ +
+**Example:** `video` + +--- +##### `composite` _string (optional)_ +
+**Example:** `/playlists/92/composite/1705716440` + +--- +##### `icon` _string (optional)_ +
+**Example:** `playlist://image.smart` + +--- +##### `viewCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `lastViewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705716298` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `7328000` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `32` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705716298` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705716440` + + diff --git a/content/types/operations/get_playlists_playlists_response_body/curl.mdx b/content/types/operations/get_playlists_playlists_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_playlists_playlists_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_playlists_response/curl.mdx b/content/types/operations/get_playlists_response/curl.mdx index 0a629e9..f37713a 100644 --- a/content/types/operations/get_playlists_response/curl.mdx +++ b/content/types/operations/get_playlists_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +returns all playlists import('/content/types/operations/get_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_playlists_playlists_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_playlists_response_body/curl.mdx b/content/types/operations/get_playlists_response_body/curl.mdx index 91839c7..008e3be 100644 --- a/content/types/operations/get_playlists_response_body/curl.mdx +++ b/content/types/operations/get_playlists_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_playlists_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_server_identity_response/curl.mdx b/content/types/operations/get_server_identity_response/curl.mdx index 35bbc05..1fb6cfb 100644 --- a/content/types/operations/get_server_identity_response/curl.mdx +++ b/content/types/operations/get_server_identity_response/curl.mdx @@ -15,7 +15,7 @@ Raw HTTP response; suitable for custom response parsing --- ##### `twoHundredApplicationJsonObject` _object (optional)_ -The Transcode Sessions +The Server Identity information import('/content/types/operations/get_server_identity_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/operations/get_server_preferences_media_container/curl.mdx b/content/types/operations/get_server_preferences_media_container/curl.mdx new file mode 100644 index 0000000..ffa652a --- /dev/null +++ b/content/types/operations/get_server_preferences_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `161` + +--- +##### `setting` _array (optional)_ +
+**Example:** `[{"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}]` + + diff --git a/content/types/operations/get_server_preferences_response/curl.mdx b/content/types/operations/get_server_preferences_response/curl.mdx index 1594a11..72130c3 100644 --- a/content/types/operations/get_server_preferences_response/curl.mdx +++ b/content/types/operations/get_server_preferences_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +Server Preferences import('/content/types/operations/get_server_preferences_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_server_preferences_server_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_server_preferences_response_body/curl.mdx b/content/types/operations/get_server_preferences_response_body/curl.mdx index 91839c7..56bcde3 100644 --- a/content/types/operations/get_server_preferences_response_body/curl.mdx +++ b/content/types/operations/get_server_preferences_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_server_preferences_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_server_preferences_server_response_body/curl.mdx b/content/types/operations/get_server_preferences_server_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_server_preferences_server_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_session_history_media_container/curl.mdx b/content/types/operations/get_session_history_media_container/curl.mdx new file mode 100644 index 0000000..5c8a341 --- /dev/null +++ b/content/types/operations/get_session_history_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `10855` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"accountID":1,"deviceID":5,"grandparentArt":"/library/metadata/32132/art/1703933346","grandparentKey":"/library/metadata/32132","grandparentThumb":"/library/metadata/32132/thumb/1703933346","grandparentTitle":"Taskmaster","historyKey":"/status/sessions/history/1","index":1,"key":"/library/metadata/32171","librarySectionID":"2","originallyAvailableAt":"2022-04-14T00:00:00Z","parentIndex":13,"parentKey":"/library/metadata/32170","parentThumb":"/library/metadata/32170/thumb/1654134301","ratingKey":"32171","thumb":"/library/metadata/32171/thumb/-1","title":"The Noise That Blue Makes","type":"episode","viewedAt":1654139223}]` + + diff --git a/content/types/operations/get_session_history_metadata/curl.mdx b/content/types/operations/get_session_history_metadata/curl.mdx new file mode 100644 index 0000000..24f1645 --- /dev/null +++ b/content/types/operations/get_session_history_metadata/curl.mdx @@ -0,0 +1,96 @@ +{/* Autogenerated DO NOT EDIT */} +##### `historyKey` _string (optional)_ +
+**Example:** `/status/sessions/history/1` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/32171` + +--- +##### `ratingKey` _string (optional)_ +
+**Example:** `32171` + +--- +##### `librarySectionID` _string (optional)_ +
+**Example:** `2` + +--- +##### `parentKey` _string (optional)_ +
+**Example:** `/library/metadata/32170` + +--- +##### `grandparentKey` _string (optional)_ +
+**Example:** `/library/metadata/32132` + +--- +##### `title` _string (optional)_ +
+**Example:** `The Noise That Blue Makes` + +--- +##### `grandparentTitle` _string (optional)_ +
+**Example:** `Taskmaster` + +--- +##### `type` _string (optional)_ +
+**Example:** `episode` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/32171/thumb/-1` + +--- +##### `parentThumb` _string (optional)_ +
+**Example:** `/library/metadata/32170/thumb/1654134301` + +--- +##### `grandparentThumb` _string (optional)_ +
+**Example:** `/library/metadata/32132/thumb/1703933346` + +--- +##### `grandparentArt` _string (optional)_ +
+**Example:** `/library/metadata/32132/art/1703933346` + +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `13` + +--- +##### `originallyAvailableAt` _date (optional)_ +
+**Example:** `2022-04-14 00:00:00 +0000 UTC` + +--- +##### `viewedAt` _integer (32-bit) (optional)_ +
+**Example:** `1654139223` + +--- +##### `accountID` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `deviceID` _integer (32-bit) (optional)_ +
+**Example:** `5` + + diff --git a/content/types/operations/get_session_history_response/curl.mdx b/content/types/operations/get_session_history_response/curl.mdx index 001f877..ae09e8d 100644 --- a/content/types/operations/get_session_history_response/curl.mdx +++ b/content/types/operations/get_session_history_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +List of Plex Sessions import('/content/types/operations/get_session_history_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_session_history_sessions_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_session_history_response_body/curl.mdx b/content/types/operations/get_session_history_response_body/curl.mdx index 91839c7..46780ea 100644 --- a/content/types/operations/get_session_history_response_body/curl.mdx +++ b/content/types/operations/get_session_history_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_session_history_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_session_history_sessions_response_body/curl.mdx b/content/types/operations/get_session_history_sessions_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_session_history_sessions_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_sessions_media/curl.mdx b/content/types/operations/get_sessions_media/curl.mdx new file mode 100644 index 0000000..75ffd93 --- /dev/null +++ b/content/types/operations/get_sessions_media/curl.mdx @@ -0,0 +1,41 @@ +{/* Autogenerated DO NOT EDIT */} +##### `audioChannels` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `audioCodec` _string (optional)_ +
+**Example:** `flac` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `1014` + +--- +##### `container` _string (optional)_ +
+**Example:** `flac` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `186240` + +--- +##### `id` _string (optional)_ +
+**Example:** `130355` + +--- +##### `selected` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `part` _array (optional)_ +
+**Example:** `[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}]` + + diff --git a/content/types/operations/get_sessions_media_container/curl.mdx b/content/types/operations/get_sessions_media_container/curl.mdx new file mode 100644 index 0000000..122272c --- /dev/null +++ b/content/types/operations/get_sessions_media_container/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"Media":[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}],"Player":{"address":"10.10.10.171","local":true,"machineIdentifier":"3tsdzir85m2onc3qyr255aq1","model":"standalone","platform":"windows","platformVersion":"10.0.22621","product":"Plex for Windows","profile":"Plex Desktop","relayed":false,"remotePublicAddress":"68.248.140.20","secure":true,"state":"playing","title":"DESKTOP-BL80MTD","userID":1,"version":"1.85.0.4071-21128b56"},"Session":{"bandwidth":1050,"id":"93h7e00ncblxncqw9lkfaoxi","location":"lan"},"User":{"id":"1","thumb":"https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661","title":"Blindkitty38"},"addedAt":1705543312,"art":"/library/metadata/39904/art/1705310687","duration":186240,"grandparentArt":"/library/metadata/39904/art/1705310687","grandparentGuid":"plex://artist/5d07bbfd403c6402904a6480","grandparentKey":"/library/metadata/39904","grandparentRatingKey":"39904","grandparentThumb":"/library/metadata/39904/thumb/1705310687","grandparentTitle":"Green Day","guid":"plex://track/6535834f71f22f36f71a8e8f","index":1,"key":"/library/metadata/67085","librarySectionID":"3","librarySectionKey":"/library/sections/3","librarySectionTitle":"Music","musicAnalysisVersion":"1","parentGuid":"plex://album/65394d6d472b8ab03ef47f12","parentIndex":1,"parentKey":"/library/metadata/67084","parentRatingKey":"67084","parentStudio":"Reprise Records","parentThumb":"/library/metadata/67084/thumb/1705543314","parentTitle":"Saviors","parentYear":2024,"ratingCount":45885,"ratingKey":"67085","sessionKey":"203","thumb":"/library/metadata/67084/thumb/1705543314","title":"The American Dream Is Killing Me","titleSort":"American Dream Is Killing Me","type":"track","updatedAt":1705543314,"viewOffset":1000}]` + + diff --git a/content/types/operations/get_sessions_metadata/curl.mdx b/content/types/operations/get_sessions_metadata/curl.mdx new file mode 100644 index 0000000..1971047 --- /dev/null +++ b/content/types/operations/get_sessions_metadata/curl.mdx @@ -0,0 +1,192 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705543312` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `186240` + +--- +##### `grandparentArt` _string (optional)_ +
+**Example:** `/library/metadata/39904/art/1705310687` + +--- +##### `grandparentGuid` _string (optional)_ +
+**Example:** `plex://artist/5d07bbfd403c6402904a6480` + +--- +##### `grandparentKey` _string (optional)_ +
+**Example:** `/library/metadata/39904` + +--- +##### `grandparentRatingKey` _string (optional)_ +
+**Example:** `39904` + +--- +##### `grandparentThumb` _string (optional)_ +
+**Example:** `/library/metadata/39904/thumb/1705310687` + +--- +##### `grandparentTitle` _string (optional)_ +
+**Example:** `Green Day` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://track/6535834f71f22f36f71a8e8f` + +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/67085` + +--- +##### `librarySectionID` _string (optional)_ +
+**Example:** `3` + +--- +##### `librarySectionKey` _string (optional)_ +
+**Example:** `/library/sections/3` + +--- +##### `librarySectionTitle` _string (optional)_ +
+**Example:** `Music` + +--- +##### `musicAnalysisVersion` _string (optional)_ +
+**Example:** `1` + +--- +##### `parentGuid` _string (optional)_ +
+**Example:** `plex://album/65394d6d472b8ab03ef47f12` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentKey` _string (optional)_ +
+**Example:** `/library/metadata/67084` + +--- +##### `parentRatingKey` _string (optional)_ +
+**Example:** `67084` + +--- +##### `parentStudio` _string (optional)_ +
+**Example:** `Reprise Records` + +--- +##### `parentThumb` _string (optional)_ +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `parentTitle` _string (optional)_ +
+**Example:** `Saviors` + +--- +##### `parentYear` _integer (32-bit) (optional)_ +
+**Example:** `2024` + +--- +##### `ratingCount` _integer (32-bit) (optional)_ +
+**Example:** `45885` + +--- +##### `ratingKey` _string (optional)_ +
+**Example:** `67085` + +--- +##### `sessionKey` _string (optional)_ +
+**Example:** `203` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/67084/thumb/1705543314` + +--- +##### `title` _string (optional)_ +
+**Example:** `The American Dream Is Killing Me` + +--- +##### `titleSort` _string (optional)_ +
+**Example:** `American Dream Is Killing Me` + +--- +##### `type` _string (optional)_ +
+**Example:** `track` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705543314` + +--- +##### `viewOffset` _integer (32-bit) (optional)_ +
+**Example:** `1000` + +--- +##### `media` _array (optional)_ +
+**Example:** `[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}]` + +--- +##### `user` _object (optional)_ + + import('/content/types/operations/user/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `player` _object (optional)_ + + import('/content/types/operations/player/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `session` _object (optional)_ + + import('/content/types/operations/session/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/operations/get_sessions_part/curl.mdx b/content/types/operations/get_sessions_part/curl.mdx new file mode 100644 index 0000000..2a6fbc8 --- /dev/null +++ b/content/types/operations/get_sessions_part/curl.mdx @@ -0,0 +1,51 @@ +{/* Autogenerated DO NOT EDIT */} +##### `container` _string (optional)_ +
+**Example:** `flac` + +--- +##### `duration` _integer (32-bit) (optional)_ +
+**Example:** `186240` + +--- +##### `file` _string (optional)_ +
+**Example:** `/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac` + +--- +##### `hasThumbnail` _string (optional)_ +
+**Example:** `1` + +--- +##### `id` _string (optional)_ +
+**Example:** `130625` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/parts/130625/1705543268/file.flac` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `23644000` + +--- +##### `decision` _string (optional)_ +
+**Example:** `directplay` + +--- +##### `selected` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `stream` _array (optional)_ +
+**Example:** `[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}]` + + diff --git a/content/types/operations/get_sessions_response/curl.mdx b/content/types/operations/get_sessions_response/curl.mdx index db1047c..2becb31 100644 --- a/content/types/operations/get_sessions_response/curl.mdx +++ b/content/types/operations/get_sessions_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +List of Active Plex Sessions import('/content/types/operations/get_sessions_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_sessions_sessions_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_sessions_response_body/curl.mdx b/content/types/operations/get_sessions_response_body/curl.mdx index 91839c7..2f3d95a 100644 --- a/content/types/operations/get_sessions_response_body/curl.mdx +++ b/content/types/operations/get_sessions_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_sessions_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_sessions_sessions_response_body/curl.mdx b/content/types/operations/get_sessions_sessions_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_sessions_sessions_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_sessions_stream/curl.mdx b/content/types/operations/get_sessions_stream/curl.mdx new file mode 100644 index 0000000..89b2f11 --- /dev/null +++ b/content/types/operations/get_sessions_stream/curl.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `albumGain` _string (optional)_ +
+**Example:** `-12.94` + +--- +##### `albumPeak` _string (optional)_ +
+**Example:** `1.000000` + +--- +##### `albumRange` _string (optional)_ +
+**Example:** `4.751014` + +--- +##### `audioChannelLayout` _string (optional)_ +
+**Example:** `stereo` + +--- +##### `bitDepth` _integer (32-bit) (optional)_ +
+**Example:** `16` + +--- +##### `bitrate` _integer (32-bit) (optional)_ +
+**Example:** `1014` + +--- +##### `channels` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `codec` _string (optional)_ +
+**Example:** `flac` + +--- +##### `displayTitle` _string (optional)_ +
+**Example:** `FLAC (Stereo)` + +--- +##### `extendedDisplayTitle` _string (optional)_ +
+**Example:** `FLAC (Stereo)` + +--- +##### `gain` _string (optional)_ +
+**Example:** `-12.94` + +--- +##### `id` _string (optional)_ +
+**Example:** `352487` + +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `0` + +--- +##### `loudness` _string (optional)_ +
+**Example:** `-5.94` + +--- +##### `lra` _string (optional)_ +
+**Example:** `1.74` + +--- +##### `peak` _string (optional)_ +
+**Example:** `1.000000` + +--- +##### `samplingRate` _integer (32-bit) (optional)_ +
+**Example:** `44100` + +--- +##### `selected` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `streamType` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `location` _string (optional)_ +
+**Example:** `direct` + + diff --git a/content/types/operations/get_transcode_sessions_media_container/curl.mdx b/content/types/operations/get_transcode_sessions_media_container/curl.mdx index 69a6116..00d0db7 100644 --- a/content/types/operations/get_transcode_sessions_media_container/curl.mdx +++ b/content/types/operations/get_transcode_sessions_media_container/curl.mdx @@ -1,9 +1,11 @@ {/* Autogenerated DO NOT EDIT */} -##### `size` _number (optional)_ +##### `size` _integer (32-bit) (optional)_
**Example:** `1` --- ##### `transcodeSession` _array (optional)_ +
+**Example:** `[{"audioChannels":1,"audioCodec":"opus","audioDecision":"transcode","complete":false,"container":"mkv","context":"streaming","duration":1445695,"error":false,"key":"vv3i2q2lax92qlzul1hbd4bx","maxOffsetAvailable":29.53,"minOffsetAvailable":3.003000020980835,"progress":1.7999999523162842,"protocol":"http","remaining":53,"size":-22,"sourceAudioCodec":"aac","sourceVideoCodec":"h264","speed":25.100000381469727,"subtitleDecision":"burn","throttled":false,"timeStamp":1705895805.4919229,"transcodeHwRequested":true,"videoCodec":"h264","videoDecision":"transcode"}]` diff --git a/content/types/operations/get_update_status_media_container/curl.mdx b/content/types/operations/get_update_status_media_container/curl.mdx new file mode 100644 index 0000000..3ec1fbd --- /dev/null +++ b/content/types/operations/get_update_status_media_container/curl.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `canInstall` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `checkedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705801232` + +--- +##### `downloadURL` _string (optional)_ +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `status` _integer (32-bit) (optional)_ +
+**Example:** `0` + +--- +##### `release` _array (optional)_ +
+**Example:** `[{"added":"(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0","downloadURL":"https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx","fixed":"(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)","key":"https://plex.tv/updater/releases/5136","state":"notify","version":"1.40.0.7775-456fbaf97"}]` + + diff --git a/content/types/operations/get_update_status_response/curl.mdx b/content/types/operations/get_update_status_response/curl.mdx index 416f409..ddd3f27 100644 --- a/content/types/operations/get_update_status_response/curl.mdx +++ b/content/types/operations/get_update_status_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ -Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. +##### `twoHundredApplicationJsonObject` _object (optional)_ +The Server Updates import('/content/types/operations/get_update_status_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_update_status_updater_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_update_status_response_body/curl.mdx b/content/types/operations/get_update_status_response_body/curl.mdx index 91839c7..ec066d3 100644 --- a/content/types/operations/get_update_status_response_body/curl.mdx +++ b/content/types/operations/get_update_status_response_body/curl.mdx @@ -1,4 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `errors` _array (optional)_ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/get_update_status_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + diff --git a/content/types/operations/get_update_status_updater_response_body/curl.mdx b/content/types/operations/get_update_status_updater_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_update_status_updater_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/guids/curl.mdx b/content/types/operations/guids/curl.mdx index 2b9520a..a6e369d 100644 --- a/content/types/operations/guids/curl.mdx +++ b/content/types/operations/guids/curl.mdx @@ -1,6 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `id` _string (optional)_
-**Example:** `imdb://tt13303712` +**Example:** `tvdb://2337` diff --git a/content/types/operations/hub/curl.mdx b/content/types/operations/hub/curl.mdx new file mode 100644 index 0000000..c2b4f1c --- /dev/null +++ b/content/types/operations/hub/curl.mdx @@ -0,0 +1,56 @@ +{/* Autogenerated DO NOT EDIT */} +##### `hubKey` _string (optional)_ +
+**Example:** `/library/metadata/50768,65523,58188,57341,57302,57070` + +--- +##### `key` _string (optional)_ +
+**Example:** `/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio` + +--- +##### `title` _string (optional)_ +
+**Example:** `Recent Playlists` + +--- +##### `type` _string (optional)_ +
+**Example:** `playlist` + +--- +##### `hubIdentifier` _string (optional)_ +
+**Example:** `home.playlists` + +--- +##### `context` _string (optional)_ +
+**Example:** `hub.home.playlists` + +--- +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `6` + +--- +##### `more` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `style` _string (optional)_ +
+**Example:** `shelf` + +--- +##### `promoted` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","icon":"playlist://image.smart","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","titleSort":"Tracks","type":"playlist","updatedAt":1668787730,"viewCount":2}]` + + diff --git a/content/types/operations/log_line_request/curl.mdx b/content/types/operations/log_line_request/curl.mdx index 488a90b..e8206ea 100644 --- a/content/types/operations/log_line_request/curl.mdx +++ b/content/types/operations/log_line_request/curl.mdx @@ -6,7 +6,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -17,9 +17,13 @@ An integer log level to write to the PMS log with. --- ##### `message` _string_ The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` _string_ a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/content/types/operations/log_multi_line_request_body/curl.mdx b/content/types/operations/log_multi_line_request_body/curl.mdx new file mode 100644 index 0000000..029a48e --- /dev/null +++ b/content/types/operations/log_multi_line_request_body/curl.mdx @@ -0,0 +1 @@ +{/* Autogenerated DO NOT EDIT */} diff --git a/content/types/operations/one/curl.mdx b/content/types/operations/one/curl.mdx new file mode 100644 index 0000000..7be302a --- /dev/null +++ b/content/types/operations/one/curl.mdx @@ -0,0 +1,44 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _string (optional)_ +
+**Example:** `FriendlyName` + +--- +##### `label` _string (optional)_ +
+**Example:** `Friendly name` + +--- +##### `summary` _string (optional)_ +
+**Example:** `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` _string (optional)_ +
+**Example:** `text` + +--- +##### `default` _string (optional)_ + +--- +##### `value` _string (optional)_ +
+**Example:** `Hera` + +--- +##### `hidden` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `advanced` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `group` _string (optional)_ +
+**Example:** `general` + + diff --git a/content/types/operations/operator/curl.mdx b/content/types/operations/operator/curl.mdx new file mode 100644 index 0000000..80c6a63 --- /dev/null +++ b/content/types/operations/operator/curl.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `=` + +--- +##### `title` _string (optional)_ +
+**Example:** `is` + + diff --git a/content/types/operations/player/curl.mdx b/content/types/operations/player/curl.mdx new file mode 100644 index 0000000..a3f3533 --- /dev/null +++ b/content/types/operations/player/curl.mdx @@ -0,0 +1,76 @@ +{/* Autogenerated DO NOT EDIT */} +##### `address` _string (optional)_ +
+**Example:** `10.10.10.171` + +--- +##### `machineIdentifier` _string (optional)_ +
+**Example:** `3tsdzir85m2onc3qyr255aq1` + +--- +##### `model` _string (optional)_ +
+**Example:** `standalone` + +--- +##### `platform` _string (optional)_ +
+**Example:** `windows` + +--- +##### `platformVersion` _string (optional)_ +
+**Example:** `10.0.22621` + +--- +##### `product` _string (optional)_ +
+**Example:** `Plex for Windows` + +--- +##### `profile` _string (optional)_ +
+**Example:** `Plex Desktop` + +--- +##### `remotePublicAddress` _string (optional)_ +
+**Example:** `68.248.140.20` + +--- +##### `state` _string (optional)_ +
+**Example:** `playing` + +--- +##### `title` _string (optional)_ +
+**Example:** `DESKTOP-BL80MTD` + +--- +##### `version` _string (optional)_ +
+**Example:** `1.85.0.4071-21128b56` + +--- +##### `local` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `relayed` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `secure` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `userID` _integer (32-bit) (optional)_ +
+**Example:** `1` + + diff --git a/content/types/operations/producer/curl.mdx b/content/types/operations/producer/curl.mdx new file mode 100644 index 0000000..72954f2 --- /dev/null +++ b/content/types/operations/producer/curl.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _integer (32-bit) (optional)_ +
+**Example:** `221` + +--- +##### `filter` _string (optional)_ +
+**Example:** `producer=221` + +--- +##### `tag` _string (optional)_ +
+**Example:** `Barry Mendel` + +--- +##### `tagKey` _string (optional)_ +
+**Example:** `5d776826961905001eb90e2b` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg` + + diff --git a/content/types/operations/ratings/curl.mdx b/content/types/operations/ratings/curl.mdx new file mode 100644 index 0000000..3c8c57d --- /dev/null +++ b/content/types/operations/ratings/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `image` _string (optional)_ +
+**Example:** `themoviedb://image.rating` + +--- +##### `value` _number (optional)_ +
+**Example:** `7.4` + +--- +##### `type` _string (optional)_ +
+**Example:** `audience` + + diff --git a/content/types/operations/release/curl.mdx b/content/types/operations/release/curl.mdx new file mode 100644 index 0000000..309329a --- /dev/null +++ b/content/types/operations/release/curl.mdx @@ -0,0 +1,46 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string (optional)_ +
+**Example:** `https://plex.tv/updater/releases/5136` + +--- +##### `version` _string (optional)_ +
+**Example:** `1.40.0.7775-456fbaf97` + +--- +##### `added` _string (optional)_ +
+**Example:** `(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish. +(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793) +(Music) Store track genres and add filtering options (#14653) +(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653) +(View History) No longer create a view history entry for items marked as played (#10888) +(Web) Updated to 4.118.0` + +--- +##### `fixed` _string (optional)_ +
+**Example:** `(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483) +(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654) +(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667) +(Collection) Server could become unresponsive when collection membership changes (#14612) +(DVR) Previously watched recordings could be deleted without being watched again (#13779) +(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501) +(Library) The Content Rating not equal to None filter does not work (#14620) +(Search) Album search results could contain all the album's tracks too (#14486) +(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674) +(Transcoder) HW encoding would fail on devices with no rate control (#14222) +(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)` + +--- +##### `downloadURL` _string (optional)_ +
+**Example:** `https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx` + +--- +##### `state` _string (optional)_ +
+**Example:** `notify` + + diff --git a/content/types/operations/response_body/curl.mdx b/content/types/operations/response_body/curl.mdx deleted file mode 100644 index b7d16a9..0000000 --- a/content/types/operations/response_body/curl.mdx +++ /dev/null @@ -1,10 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `mediaContainer` _object (optional)_ - - import('/content/types/operations/get_available_clients_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/operations/session/curl.mdx b/content/types/operations/session/curl.mdx new file mode 100644 index 0000000..e59059f --- /dev/null +++ b/content/types/operations/session/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _string (optional)_ +
+**Example:** `93h7e00ncblxncqw9lkfaoxi` + +--- +##### `bandwidth` _integer (32-bit) (optional)_ +
+**Example:** `1050` + +--- +##### `location` _string (optional)_ +
+**Example:** `lan` + + diff --git a/content/types/operations/setting/curl.mdx b/content/types/operations/setting/curl.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/types/operations/setting/curl.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/types/operations/sort/curl.mdx b/content/types/operations/sort/curl.mdx new file mode 100644 index 0000000..b0977ec --- /dev/null +++ b/content/types/operations/sort/curl.mdx @@ -0,0 +1,31 @@ +{/* Autogenerated DO NOT EDIT */} +##### `default` _string (optional)_ +
+**Example:** `asc` + +--- +##### `defaultDirection` _string (optional)_ +
+**Example:** `desc` + +--- +##### `descKey` _string (optional)_ +
+**Example:** `random:desc` + +--- +##### `firstCharacterKey` _string (optional)_ +
+**Example:** `/library/sections/1/firstCharacter` + +--- +##### `key` _string (optional)_ +
+**Example:** `random` + +--- +##### `title` _string (optional)_ +
+**Example:** `Randomly` + + diff --git a/content/types/operations/stream/curl.mdx b/content/types/operations/stream/curl.mdx index 3c29888..ee9ba63 100644 --- a/content/types/operations/stream/curl.mdx +++ b/content/types/operations/stream/curl.mdx @@ -1,30 +1,142 @@ {/* Autogenerated DO NOT EDIT */} -##### `id` _number (optional)_ +##### `id` _integer (32-bit) (optional)_
-**Example:** `211234` +**Example:** `29` --- -##### `streamType` _number (optional)_ +##### `streamType` _integer (32-bit) (optional)_
-**Example:** `1` +**Example:** `2` --- ##### `default` _boolean (optional)_ +
+**Example:** `true` --- ##### `codec` _string (optional)_
-**Example:** `hevc` +**Example:** `aac` --- -##### `index` _number (optional)_ +##### `index` _integer (32-bit) (optional)_
**Example:** `0` --- -##### `bitrate` _number (optional)_ +##### `bitrate` _integer (32-bit) (optional)_
-**Example:** `918` +**Example:** `128` + +--- +##### `bitDepth` _integer (32-bit) (optional)_ +
+**Example:** `8` + +--- +##### `chromaLocation` _string (optional)_ +
+**Example:** `left` + +--- +##### `chromaSubsampling` _string (optional)_ +
+**Example:** `14520` + +--- +##### `codedHeight` _integer (32-bit) (optional)_ +
+**Example:** `816` + +--- +##### `codedWidth` _integer (32-bit) (optional)_ +
+**Example:** `1920` + +--- +##### `colorPrimaries` _string (optional)_ +
+**Example:** `bt709` + +--- +##### `colorRange` _string (optional)_ +
+**Example:** `tv` + +--- +##### `colorSpace` _string (optional)_ +
+**Example:** `bt709` + +--- +##### `colorTrc` _string (optional)_ +
+**Example:** `bt709` + +--- +##### `frameRate` _integer (32-bit) (optional)_ +
+**Example:** `24` + +--- +##### `hasScalingMatrix` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `height` _integer (32-bit) (optional)_ +
+**Example:** `814` + +--- +##### `level` _integer (32-bit) (optional)_ +
+**Example:** `40` + +--- +##### `profile` _string (optional)_ +
+**Example:** `lc` + +--- +##### `refFrames` _integer (32-bit) (optional)_ +
+**Example:** `4` + +--- +##### `scanType` _string (optional)_ +
+**Example:** `progressive` + +--- +##### `streamIdentifier` _string (optional)_ +
+**Example:** `1` + +--- +##### `width` _integer (32-bit) (optional)_ +
+**Example:** `1920` + +--- +##### `displayTitle` _string (optional)_ +
+**Example:** `English (AAC Stereo)` + +--- +##### `extendedDisplayTitle` _string (optional)_ +
+**Example:** `English (AAC Stereo)` + +--- +##### `selected` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `channels` _integer (32-bit) (optional)_ +
+**Example:** `2` --- ##### `language` _string (optional)_ @@ -42,73 +154,8 @@ **Example:** `eng` --- -##### `bitDepth` _number (optional)_ +##### `samplingRate` _integer (32-bit) (optional)_
-**Example:** `8` - ---- -##### `chromaLocation` _string (optional)_ -
-**Example:** `left` - ---- -##### `chromaSubsampling` _string (optional)_ -
-**Example:** `4:2:0` - ---- -##### `codedHeight` _number (optional)_ -
-**Example:** `1080` - ---- -##### `codedWidth` _number (optional)_ -
-**Example:** `1920` - ---- -##### `colorRange` _string (optional)_ -
-**Example:** `tv` - ---- -##### `frameRate` _number (optional)_ -
-**Example:** `25` - ---- -##### `height` _number (optional)_ -
-**Example:** `1080` - ---- -##### `level` _number (optional)_ -
-**Example:** `120` - ---- -##### `profile` _string (optional)_ -
-**Example:** `main` - ---- -##### `refFrames` _number (optional)_ -
-**Example:** `1` - ---- -##### `width` _number (optional)_ -
-**Example:** `1920` - ---- -##### `displayTitle` _string (optional)_ -
-**Example:** `1080p (HEVC Main)` - ---- -##### `extendedDisplayTitle` _string (optional)_ -
-**Example:** `1080p (HEVC Main)` +**Example:** `44100` diff --git a/content/types/operations/tag/curl.mdx b/content/types/operations/tag/curl.mdx new file mode 100644 index 0000000..5f93366 --- /dev/null +++ b/content/types/operations/tag/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} + +Allowed values: `all` `unwatched` `newest` `recentlyAdded` `recentlyViewed` `onDeck` `collection` `edition` `genre` `year` `decade` `director` `actor` `country` `contentRating` `rating` `resolution` `firstCharacter` `folder` `search?type=1` + diff --git a/content/types/operations/transcode_session/curl.mdx b/content/types/operations/transcode_session/curl.mdx index cb44a24..b892648 100644 --- a/content/types/operations/transcode_session/curl.mdx +++ b/content/types/operations/transcode_session/curl.mdx @@ -1,36 +1,47 @@ {/* Autogenerated DO NOT EDIT */} ##### `key` _string (optional)_
-**Example:** `zz7llzqlx8w9vnrsbnwhbmep` +**Example:** `vv3i2q2lax92qlzul1hbd4bx` --- ##### `throttled` _boolean (optional)_ +
+**Example:** `false` --- ##### `complete` _boolean (optional)_ +
+**Example:** `false` --- ##### `progress` _number (optional)_
-**Example:** `0.4000000059604645` +**Example:** `1.7999999523162842` --- -##### `size` _number (optional)_ +##### `size` _integer (32-bit) (optional)_
**Example:** `-22` --- ##### `speed` _number (optional)_
-**Example:** `22.399999618530273` +**Example:** `25.100000381469727` --- ##### `error` _boolean (optional)_ +
+**Example:** `false` --- -##### `duration` _number (optional)_ +##### `duration` _integer (32-bit) (optional)_
-**Example:** `2561768` +**Example:** `1445695` + +--- +##### `remaining` _integer (32-bit) (optional)_ +
+**Example:** `53` --- ##### `context` _string (optional)_ @@ -45,7 +56,7 @@ --- ##### `sourceAudioCodec` _string (optional)_
-**Example:** `ac3` +**Example:** `aac` --- ##### `videoDecision` _string (optional)_ @@ -57,6 +68,11 @@
**Example:** `transcode` +--- +##### `subtitleDecision` _string (optional)_ +
+**Example:** `burn` + --- ##### `protocol` _string (optional)_
@@ -78,26 +94,28 @@ **Example:** `opus` --- -##### `audioChannels` _number (optional)_ +##### `audioChannels` _integer (32-bit) (optional)_
-**Example:** `2` +**Example:** `1` --- ##### `transcodeHwRequested` _boolean (optional)_ +
+**Example:** `true` --- ##### `timeStamp` _number (optional)_
-**Example:** `1.6818695357764285e+09` +**Example:** `1.7058958054919229e+09` --- ##### `maxOffsetAvailable` _number (optional)_
-**Example:** `861.778` +**Example:** `29.53` --- ##### `minOffsetAvailable` _number (optional)_
-**Example:** `0` +**Example:** `3.003000020980835` diff --git a/content/types/operations/two/curl.mdx b/content/types/operations/two/curl.mdx new file mode 100644 index 0000000..6c9a54e --- /dev/null +++ b/content/types/operations/two/curl.mdx @@ -0,0 +1,49 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _string (optional)_ +
+**Example:** `ScheduledLibraryUpdateInterval` + +--- +##### `label` _string (optional)_ +
+**Example:** `Library scan interval` + +--- +##### `summary` _string (optional)_ + +--- +##### `type` _string (optional)_ +
+**Example:** `int` + +--- +##### `default` _integer (32-bit) (optional)_ +
+**Example:** `3600` + +--- +##### `value` _integer (32-bit) (optional)_ +
+**Example:** `3600` + +--- +##### `hidden` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `advanced` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `group` _string (optional)_ +
+**Example:** `library` + +--- +##### `enumValues` _string (optional)_ +
+**Example:** `900:every 15 minutes|1800:every 30 minutes|3600:hourly|7200:every 2 hours|21600:every 6 hours|43200:every 12 hours|86400:daily` + + diff --git a/content/types/operations/update_playlist_request/curl.mdx b/content/types/operations/update_playlist_request/curl.mdx index 6e2026a..ca29e25 100644 --- a/content/types/operations/update_playlist_request/curl.mdx +++ b/content/types/operations/update_playlist_request/curl.mdx @@ -2,4 +2,12 @@ ##### `playlistID` _number_ the ID of the playlist +--- +##### `title` _string (optional)_ +name of the playlist + +--- +##### `summary` _string (optional)_ +summary description of the playlist + diff --git a/content/types/operations/upload_playlist_request/curl.mdx b/content/types/operations/upload_playlist_request/curl.mdx index 0923546..26b7f78 100644 --- a/content/types/operations/upload_playlist_request/curl.mdx +++ b/content/types/operations/upload_playlist_request/curl.mdx @@ -15,8 +15,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` _enumeration_ -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. import('/content/types/operations/force/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/operations/user/curl.mdx b/content/types/operations/user/curl.mdx new file mode 100644 index 0000000..b2d37d8 --- /dev/null +++ b/content/types/operations/user/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `id` _string (optional)_ +
+**Example:** `1` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661` + +--- +##### `title` _string (optional)_ +
+**Example:** `Blindkitty38` + + diff --git a/gen.yaml b/gen.yaml index 8589b9d..62b71b6 100644 --- a/gen.yaml +++ b/gen.yaml @@ -7,7 +7,7 @@ generation: fixes: nameResolutionDec2023: false docs: - version: 0.1.1 + version: 0.2.0 defaultLanguage: go imports: option: openapi diff --git a/package.json b/package.json index d8f0bf0..309b218 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sdk-docs", - "version": "0.1.1", + "version": "0.2.0", "description": "Nextra docs template", "private": true, "scripts": { diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx index b4d1b4e..4d3e5d6 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetGlobalHubsMediaContainer from "/content/types/operations/get_global_hubs_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx index 42ee115..81a1eef 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx @@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/hubs?count=567.13 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx index b4d1b4e..cc30f05 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryHubsMediaContainer from "/content/types/operations/get_library_hubs_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx index b72f0c7..62afa3f 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx @@ -9,13 +9,15 @@ curl http://10.10.10.47:32400/hubs/sections/9636.63?count=2726.56 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx deleted file mode 100644 index ac82b0b..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### API key _— in HTTP header_ - -Set your API key in a `X-Plex-Token` HTTP header. - -Example: `` - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index 48d0dc6..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import OperationInfo from '/src/components/OperationInfo'; - -## Get Common Library Items - - - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index 3d2d98d..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 1990960..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,30 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} - -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; -import { TabbedSection, Tab } from '@/src/components/TabbedSection'; -import StatusCode from '@/src/components/StatusCode'; - - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - *JSON object* - - ##### `errors` _array (optional)_ - - - - - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 1539dba..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,21 +0,0 @@ - - -```bash Example Request -curl http://10.10.10.47:32400/library/sections/8360.79/common?filter=string&type=710.36 \ ---header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index a17dd2f..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetCommonLibraryItems from './get_common_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items_content.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx deleted file mode 100644 index ac82b0b..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### API key _— in HTTP header_ - -Set your API key in a `X-Plex-Token` HTTP header. - -Example: `` - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index f3df705..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,8 +0,0 @@ -import OperationInfo from '/src/components/OperationInfo'; - -## Get Latest Library Items - - - -This endpoint will return a list of the latest library items filtered by the filter and type provided - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index 3d2d98d..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ -the Id of the library to query - ---- -##### `type` _number_ -item type - ---- -##### `filter` _string (optional)_ -the filter parameter - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index b4d1b4e..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} - -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; -import { TabbedSection, Tab } from '@/src/components/TabbedSection'; -import StatusCode from '@/src/components/StatusCode'; - - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> - *JSON object* - - ##### `errors` _array (optional)_ - - - - - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 3dbfef7..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,21 +0,0 @@ - - -```bash Example Request -curl http://10.10.10.47:32400/library/sections/3927.85/latest?filter=string&type=9255.97 \ ---header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index db52f93..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetLatestLibraryItems from './get_latest_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items_content.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library/_header.mdx index 4361404..3ba4687 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library/_header.mdx @@ -4,23 +4,43 @@ import OperationInfo from '/src/components/OperationInfo'; -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library/_response.mdx index b4d1b4e..a96c2cc 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryMediaContainer from "/content/types/operations/get_library_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx index 8afc760..9678365 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx @@ -9,13 +9,23 @@ curl http://10.10.10.47:32400/library/sections/1000 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx index bc8090d..5027190 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx @@ -2,7 +2,27 @@ import OperationInfo from '/src/components/OperationInfo'; ## Get Library Items - + -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx index 95cc82a..56fb06d 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx @@ -1,12 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `sectionId` _number_ +import Tag from "/content/types/operations/tag/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ the Id of the library to query --- -##### `type` _number (optional)_ -item type +##### `tag` _enumeration_ +A key representing a specific tag within the section. ---- -##### `filter` _string (optional)_ -the filter parameter + + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx index b4d1b4e..b2b7df3 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetLibraryItemsMediaContainer from "/content/types/operations/get_library_items_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,18 +9,13 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ - - {/* prettier-ignore */} - }> - _No response body._ - - {/* prettier-ignore */} - }> *JSON object* - ##### `errors` _array (optional)_ - + ##### `MediaContainer` _object (optional)_ + + + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index 13d4929..cad2b5e 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/5288.95/all?filter=string&type=4799.77 \ +curl http://10.10.10.47:32400/library/sections/528895/{{tag}} \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,23 @@ curl http://10.10.10.47:32400/library/sections/5288.95/all?filter=string&type=47 ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_response.mdx index b4d1b4e..3466082 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetMetadataMediaContainer from "/content/types/operations/get_metadata_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 93ed8b3..1992ca0 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/3373.96 \ +curl http://10.10.10.47:32400/library/metadata/5680.45 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,17 @@ curl http://10.10.10.47:32400/library/metadata/3373.96 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx index b4d1b4e..4bf1491 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetMetadataChildrenMediaContainer from "/content/types/operations/get_metadata_children_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 16cdd79..73dc215 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/871.29/children \ +curl http://10.10.10.47:32400/library/metadata/3927.85/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,31 @@ curl http://10.10.10.47:32400/library/metadata/871.29/children \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx b/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx index 3b5c394..dbc7380 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/curl/library/delete_library) - Delete Library Section * [Get Library Items](/curl/library/get_library_items) - Get Library Items * [Refresh Library](/curl/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/curl/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/curl/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/curl/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children * [Get On Deck](/curl/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx index df64a68..c51d37a 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/5680.45/refresh \ +curl http://10.10.10.47:32400/library/sections/4799.77/refresh \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/log/log_line/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/log/log_line/_parameters.mdx index b55b9a3..b6ecd5b 100644 --- a/src/.gen/pages/01-reference/curl/resources/log/log_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -19,8 +19,12 @@ An integer log level to write to the PMS log with. --- ##### `message` _string_ The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` _string_ a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/src/.gen/pages/01-reference/curl/resources/log/log_line/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/log/log_line/_usage.mdx index 188f4d6..751fd6a 100644 --- a/src/.gen/pages/01-reference/curl/resources/log/log_line/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/log/log_line/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/log?message=string&source=string \ +curl http://10.10.10.47:32400/log?message=Test%20log%20message&source=Postman \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx b/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx index 3a5596d..b528708 100644 --- a/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx @@ -4,5 +4,25 @@ import OperationInfo from '/src/components/OperationInfo'; -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx index 929b020..1e28503 100644 --- a/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx @@ -1,2 +1,9 @@ {/* Autogenerated DO NOT EDIT */} +import LogMultiLineRequestBody from "/content/types/operations/log_multi_line_request_body/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Request Body` __ + + diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx index 1f25b87..38b0a04 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx @@ -4,6 +4,6 @@ import OperationInfo from '/src/components/OperationInfo'; -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx index fb33aec..96b7d29 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` _string_ the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID` _number_ +##### `playQueueID` _number (optional)_ the play queue to add to a playlist
**Example:** `123` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx index b4d1b4e..30f49f8 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import AddPlaylistContentsMediaContainer from "/content/types/operations/add_playlist_contents_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index 46ef29a..c08b4a6 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8700.13/items?playQueueID=123&uri=library%3A%2F%2F.. \ +curl http://10.10.10.47:32400/playlists/3682.41/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,12 @@ curl http://10.10.10.47:32400/playlists/8700.13/items?playQueueID=123&uri=librar ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index 734c63b..fb23a7e 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/1403.5/items \ +curl http://10.10.10.47:32400/playlists/202.18/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx index 041613e..61c7063 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx @@ -5,6 +5,6 @@ import OperationInfo from '/src/components/OperationInfo'; Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx index 3988550..b6b73de 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx @@ -24,7 +24,7 @@ whether the playlist is smart or not --- -##### `uri` _string (optional)_ +##### `uri` _string_ the content URI for the playlist --- diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx index b4d1b4e..4572491 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import CreatePlaylistMediaContainer from "/content/types/operations/create_playlist_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 01b3a54..75d9c51 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=6481.72&title=string&uri=string \ +curl http://10.10.10.47:32400/playlists?playQueueID=9255.97&title=string&uri=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists?playQueueID=6481.72&title=string&uri=str ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 8678211..398e8d7 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3682.41 \ +curl http://10.10.10.47:32400/playlists/710.36 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx index b4d1b4e..51893dd 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistMediaContainer from "/content/types/operations/get_playlist_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index e4f1206..00e1dc3 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/202.18 \ +curl http://10.10.10.47:32400/playlists/8360.79 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists/202.18 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx index b4d1b4e..56e1182 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistContentsMediaContainer from "/content/types/operations/get_playlist_contents_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index 1d8a9b7..c827cad 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9571.56/items?type=7781.57 \ +curl http://10.10.10.47:32400/playlists/871.29/items?type=6481.72 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,17 @@ curl http://10.10.10.47:32400/playlists/9571.56/items?type=7781.57 \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx index d2ebc33..9f5bd4b 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx @@ -2,6 +2,6 @@ import OperationInfo from '/src/components/OperationInfo'; ## Get Playlists - + Get All Playlists given the specified filters. diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx index b4d1b4e..e857ba6 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetPlaylistsMediaContainer from "/content/types/operations/get_playlists_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx index dcbde8a..56a868b 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/all \ +curl http://10.10.10.47:32400/playlists \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/playlists/all \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx index d416598..4d19f8b 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx @@ -2,3 +2,11 @@ ##### `playlistID` _number_ the ID of the playlist +--- +##### `title` _string (optional)_ +name of the playlist + +--- +##### `summary` _string (optional)_ +summary description of the playlist + diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index 7b9f1aa..32bc5cd 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8326.2 \ +curl http://10.10.10.47:32400/playlists/3373.96?summary=string&title=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx index aaf8bc0..6178e07 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` _enumeration_ -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx b/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx index b4d1b4e..1ca619b 100644 --- a/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetAvailableClientsMediaContainer from "/content/types/operations/get_available_clients_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx index 994b300..11f35ff 100644 --- a/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_usage.mdx @@ -8,27 +8,25 @@ curl http://10.10.10.47:32400/clients \ --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx index b4d1b4e..75e7d00 100644 --- a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetServerPreferencesMediaContainer from "/content/types/operations/get_server_preferences_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx index afef627..23931ef 100644 --- a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/:/prefs \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx index b4d1b4e..d0fd060 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetSessionHistoryMediaContainer from "/content/types/operations/get_session_history_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx index 536d74d..ad383cc 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/status/sessions/history/all \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx index b4d1b4e..6184ec0 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetSessionsMediaContainer from "/content/types/operations/get_sessions_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx index 192d04d..9488a0c 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx @@ -9,13 +9,10 @@ curl http://10.10.10.47:32400/status/sessions \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx index a73d785..d6008bf 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_transcode_sessions/_usage.mdx @@ -11,32 +11,7 @@ curl http://10.10.10.47:32400/transcode/sessions \ { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx index b4d1b4e..6a89487 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/stop_transcode_session/_response.mdx @@ -7,7 +7,7 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} - }> + }> _No response body._ {/* prettier-ignore */} diff --git a/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx b/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx index b4d1b4e..979c811 100644 --- a/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_response.mdx @@ -1,4 +1,5 @@ {/* Autogenerated DO NOT EDIT */} +import GetUpdateStatusMediaContainer from "/content/types/operations/get_update_status_media_container/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +9,15 @@ import StatusCode from '@/src/components/StatusCode'; {/* prettier-ignore */} }> - _No response body._ + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + {/* prettier-ignore */} }> diff --git a/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx index e0e7b37..9a25836 100644 --- a/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/updater/get_update_status/_usage.mdx @@ -9,13 +9,14 @@ curl http://10.10.10.47:32400/updater/status \ ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index 041f591..cefdf4e 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=string&duration=9446.69&hasMDE=1433.53&key=string&playBackTime=5218.48&playQueueItemID=7586.16&ratingKey=5820.2&row=1059.07&time=5373.73 \ +curl http://10.10.10.47:32400/:/timeline?context=string&duration=7206.33&hasMDE=6788.8&key=string&playBackTime=5820.2&playQueueItemID=6399.21&ratingKey=7805.29&row=1433.53&time=1182.74 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index cb9f677..5ac2ead 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=7206.33&audioBoost=6788.8&autoAdjustQuality=6399.21&directPlay=4614.79&directStream=5204.78&fastSeek=8009.11&hasMDE=9786.19&location=string&mediaBufferSize=1182.74&mediaIndex=4736.08&partIndex=7991.59&path=string&protocol=string&session=string&subtites=string&subtitleSize=7805.29 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4614.79&audioBoost=7991.59&autoAdjustQuality=5204.78&directPlay=8700.88&directStream=9786.19&fastSeek=8700.13&hasMDE=9571.56&location=string&mediaBufferSize=8009.11&mediaIndex=7781.57&partIndex=1403.5&path=string&protocol=string&session=string&subtites=string&subtitleSize=4736.08 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx b/src/.gen/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx index 63af3ce..5dc50d9 100644 --- a/src/.gen/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/hubs/get_global_hubs/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,12 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx b/src/.gen/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx index b878c55..1e70b70 100644 --- a/src/.gen/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/hubs/get_library_hubs/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -30,7 +29,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -39,13 +38,15 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index 3f642ed..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `sectionID` *{`float64`}* -the Id of the library to query - ---- -##### `type_` *{`float64`}* -item type - ---- -##### `filter` *{`*string`}* -the filter parameter - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 93f23a3..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetCommonLibraryItemsResponse`}* - - - - - - ---- -##### *{`error`}* - - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 574beb7..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - -```go GetCommonLibraryItems.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" - "net/http" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var sectionID float64 = 5288.95 - - var type_ float64 = 4799.77 - - var filter *string = "string" - - ctx := context.Background() - res, err := s.Library.GetCommonLibraryItems(ctx, sectionID, type_, filter) - if err != nil { - log.Fatal(err) - } - - if res.StatusCode == http.StatusOK { - // handle response - } -} -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index a17dd2f..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetCommonLibraryItems from './get_common_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items_content.mdx b/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_common_library_items/get_common_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index 3f642ed..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `sectionID` *{`float64`}* -the Id of the library to query - ---- -##### `type_` *{`float64`}* -item type - ---- -##### `filter` *{`*string`}* -the filter parameter - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index b2a3e30..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,16 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetLatestLibraryItemsResponse`}* - - - - - - ---- -##### *{`error`}* - - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 51edaa5..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,50 +0,0 @@ - - -```go GetLatestLibraryItems.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" - "net/http" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var sectionID float64 = 7917.25 - - var type_ float64 = 8121.69 - - var filter *string = "string" - - ctx := context.Background() - res, err := s.Library.GetLatestLibraryItems(ctx, sectionID, type_, filter) - if err != nil { - log.Fatal(err) - } - - if res.StatusCode == http.StatusOK { - // handle response - } -} -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index db52f93..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetLatestLibraryItems from './get_latest_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items_content.mdx b/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/go/resources/library/get_latest_library_items/get_latest_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library/_usage.mdx index b10a988..e60d37c 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,23 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx index 9da6954..68b5816 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_parameters.mdx @@ -1,16 +1,20 @@ {/* Autogenerated DO NOT EDIT */} +import Tag from "/content/types/models/operations/tag/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) The context to use for the request. --- -##### `sectionID` *{`float64`}* +##### `sectionID` *{`int64`}* the Id of the library to query --- -##### `type_` *{`*float64`}* -item type +##### `tag` *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter` *{`*string`}* -the filter parameter + + + diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx index 94b40de..2d0f43a 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx @@ -6,9 +6,9 @@ package main import( "github.com/LukeHagar/plexgo/models/components" "github.com/LukeHagar/plexgo" + "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -17,19 +17,17 @@ func main() { ) - var sectionID float64 = 2726.56 + var sectionID int64 = 272656 - var type_ *float64 = 3834.41 - - var filter *string = "string" + var tag operations.Tag = operations.TagEdition ctx := context.Background() - res, err := s.Library.GetLibraryItems(ctx, sectionID, type_, filter) + res, err := s.Library.GetLibraryItems(ctx, sectionID, tag) if err != nil { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -38,13 +36,23 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx index 68f66f8..ecc687b 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -17,7 +16,7 @@ func main() { ) - var ratingKey float64 = 5680.45 + var ratingKey float64 = 7917.25 ctx := context.Background() res, err := s.Library.GetMetadata(ctx, ratingKey) @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,17 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx index 8bf8450..54d793a 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -17,7 +16,7 @@ func main() { ) - var ratingKey float64 = 3927.85 + var ratingKey float64 = 8121.69 ctx := context.Background() res, err := s.Library.GetMetadataChildren(ctx, ratingKey) @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,31 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/library_content.mdx b/src/.gen/pages/01-reference/go/resources/library/library_content.mdx index 97e8d10..6fba642 100644 --- a/src/.gen/pages/01-reference/go/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/library_content.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/go/library/delete_library) - Delete Library Section * [Get Library Items](/go/library/get_library_items) - Get Library Items * [Refresh Library](/go/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/go/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/go/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/go/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children * [Get On Deck](/go/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/src/.gen/pages/01-reference/go/resources/log/log_line/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/log/log_line/_parameters.mdx index 228c7a3..d5599b5 100644 --- a/src/.gen/pages/01-reference/go/resources/log/log_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/log/log_line/_parameters.mdx @@ -11,7 +11,7 @@ The context to use for the request. An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -23,8 +23,12 @@ An integer log level to write to the PMS log with. --- ##### `message` *{`string`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` *{`string`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/src/.gen/pages/01-reference/go/resources/log/log_line/_usage.mdx b/src/.gen/pages/01-reference/go/resources/log/log_line/_usage.mdx index 07d1611..438c6ca 100644 --- a/src/.gen/pages/01-reference/go/resources/log/log_line/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/log/log_line/_usage.mdx @@ -18,11 +18,11 @@ func main() { ) - var level operations.Level = operations.LevelFour + var level operations.Level = operations.LevelTwo - var message string = "string" + var message string = "Test log message" - var source string = "string" + var source string = "Postman" ctx := context.Background() res, err := s.Log.LogLine(ctx, level, message, source) diff --git a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_header.mdx b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx index 186de0c..4f061b2 100644 --- a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_parameters.mdx @@ -2,3 +2,7 @@ ##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) The context to use for the request. +--- +##### `request` *{`string`}* +The request object to use for the request. + diff --git a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx index b34e41d..a447756 100644 --- a/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/log/log_multi_line/_usage.mdx @@ -17,7 +17,9 @@ func main() { ) ctx := context.Background() - res, err := s.Log.LogMultiLine(ctx) + res, err := s.Log.LogMultiLine(ctx, "level=4&message=Test%20message%201&source=postman +level=3&message=Test%20message%202&source=postman +level=1&message=Test%20message%203&source=postman") if err != nil { log.Fatal(err) } diff --git a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx index 94ed5d5..c010450 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_parameters.mdx @@ -10,10 +10,10 @@ the ID of the playlist ##### `uri` *{`string`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `playQueueID` *{`float64`}* +##### `playQueueID` *{`*float64`}* the play queue to add to a playlist
**Example:** `123` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx index 15e6c92..eef517a 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -19,9 +18,9 @@ func main() { var playlistID float64 = 1403.5 - var uri string = "library://.." + var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1" - var playQueueID float64 = 123 + var playQueueID *float64 = 123 ctx := context.Background() res, err := s.Playlists.AddPlaylistContents(ctx, playlistID, uri, playQueueID) @@ -29,7 +28,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -38,13 +37,12 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx index 22d1428..4e21e98 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx @@ -9,7 +9,6 @@ import( "context" "github.com/LukeHagar/plexgo/models/operations" "log" - "net/http" ) func main() { @@ -20,14 +19,15 @@ func main() { ctx := context.Background() res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{ Title: "string", - Type: operations.TypePhoto, - Smart: operations.SmartZero, + Type: operations.TypeVideo, + Smart: operations.SmartOne, + URI: "http://velvety-spiderling.com", }) if err != nil { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -36,13 +36,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx index 440d6b8..efe3b2f 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -25,7 +24,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -34,13 +33,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx index 5e76182..e537c19 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -27,7 +26,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -36,13 +35,17 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx index 0e8055c..5b46ce3 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/get_playlists/_usage.mdx @@ -9,7 +9,6 @@ import( "github.com/LukeHagar/plexgo/models/operations" "context" "log" - "net/http" ) func main() { @@ -28,7 +27,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -37,13 +36,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx index 99bccc8..7675191 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_parameters.mdx @@ -6,3 +6,11 @@ The context to use for the request. ##### `playlistID` *{`float64`}* the ID of the playlist +--- +##### `title` *{`*string`}* +name of the playlist + +--- +##### `summary` *{`*string`}* +summary description of the playlist + diff --git a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx index f3ba6ff..e85835a 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx @@ -19,8 +19,12 @@ func main() { var playlistID float64 = 3682.41 + var title *string = "string" + + var summary *string = "string" + ctx := context.Background() - res, err := s.Playlists.UpdatePlaylist(ctx, playlistID) + res, err := s.Playlists.UpdatePlaylist(ctx, playlistID, title, summary) if err != nil { log.Fatal(err) } diff --git a/src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx index 10a2258..eb6572c 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/_parameters.mdx @@ -20,8 +20,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/src/.gen/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx b/src/.gen/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx index cd89fed..4ba090a 100644 --- a/src/.gen/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/server/get_available_clients/_usage.mdx @@ -21,7 +21,7 @@ func main() { log.Fatal(err) } - if res.Classes != nil { + if res.Object != nil { // handle response } } @@ -29,27 +29,25 @@ func main() { --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/src/.gen/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx b/src/.gen/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx index fc17139..9765146 100644 --- a/src/.gen/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/server/get_server_preferences/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx b/src/.gen/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx index 944c0f4..191fbd7 100644 --- a/src/.gen/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/sessions/get_session_history/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx b/src/.gen/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx index d610282..b86b3ef 100644 --- a/src/.gen/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/sessions/get_sessions/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,10 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx b/src/.gen/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx index eded734..00ca871 100644 --- a/src/.gen/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/sessions/get_transcode_sessions/_usage.mdx @@ -32,32 +32,7 @@ func main() { { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/src/.gen/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx b/src/.gen/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx index b076862..34963ab 100644 --- a/src/.gen/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/updater/get_update_status/_usage.mdx @@ -8,7 +8,6 @@ import( "github.com/LukeHagar/plexgo" "context" "log" - "net/http" ) func main() { @@ -22,7 +21,7 @@ func main() { log.Fatal(err) } - if res.StatusCode == http.StatusOK { + if res.Object != nil { // handle response } } @@ -31,13 +30,14 @@ func main() { ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx b/src/.gen/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx index f5847fa..ba11801 100644 --- a/src/.gen/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/hubs/get_global_hubs/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.hubs.get_global_hubs(count=8472.52, only_transient=operations.OnlyTransient.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,12 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx b/src/.gen/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx index e322510..3064467 100644 --- a/src/.gen/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/hubs/get_library_hubs/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.hubs.get_library_hubs(section_id=6235.64, count=6458.94, only_transient=operations.QueryParamOnlyTransient.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,15 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index c16bb37..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 5e40acb..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetCommonLibraryItemsResponse`}* - - - - - - - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 10a1254..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - -```python GetCommonLibraryItems.py -import plex_api -from plex_api.models import operations - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.library.get_common_library_items(section_id=5288.95, type=4799.77, filter_='string') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index a17dd2f..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetCommonLibraryItems from './get_common_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items_content.mdx b/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_common_library_items/get_common_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index c16bb37..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,12 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* -the Id of the library to query - ---- -##### `type` *{`float`}* -item type - ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index 2ed87f8..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetLatestLibraryItemsResponse`}* - - - - - - - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index ab20568..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,31 +0,0 @@ - - -```python GetLatestLibraryItems.py -import plex_api -from plex_api.models import operations - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.library.get_latest_library_items(section_id=7917.25, type=8121.69, filter_='string') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index db52f93..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetLatestLibraryItems from './get_latest_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items_content.mdx b/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/python/resources/library/get_latest_library_items/get_latest_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library/_usage.mdx index 20a4a35..9c9cd38 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.library.get_library(section_id=1000, include_details=operations.IncludeDetails.ONE) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,23 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx index c7573a5..65a4873 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_parameters.mdx @@ -1,12 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `section_id` *{`float`}* +import Tag from "/content/types/models/operations/tag/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* the Id of the library to query --- -##### `type` *{`Optional[float]`}* -item type +##### `tag` *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter_` *{`Optional[str]`}* -the filter parameter + + + diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx index aacad90..923bcd0 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_library_items(section_id=2726.56, type=3834.41, filter_='string') +res = s.library.get_library_items(section_id=272656, tag=operations.Tag.EDITION) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,23 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx index 443c483..c76aad7 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata(rating_key=5680.45) +res = s.library.get_metadata(rating_key=7917.25) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,17 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx index 62fe4f6..1433ae8 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata_children(rating_key=3927.85) +res = s.library.get_metadata_children(rating_key=8121.69) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,31 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/library/library_content.mdx b/src/.gen/pages/01-reference/python/resources/library/library_content.mdx index eb97081..e5ecced 100644 --- a/src/.gen/pages/01-reference/python/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/library_content.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/python/library/delete_library) - Delete Library Section * [Get Library Items](/python/library/get_library_items) - Get Library Items * [Refresh Library](/python/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/python/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/python/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/python/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children * [Get On Deck](/python/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/src/.gen/pages/01-reference/python/resources/log/log_line/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/log/log_line/_parameters.mdx index 4effeb2..3cb00ec 100644 --- a/src/.gen/pages/01-reference/python/resources/log/log_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose @@ -19,8 +19,12 @@ An integer log level to write to the PMS log with. --- ##### `message` *{`str`}* The text of the message to write to the log. +
+**Example:** `Test log message` --- ##### `source` *{`str`}* a string indicating the source of the message. +
+**Example:** `Postman` diff --git a/src/.gen/pages/01-reference/python/resources/log/log_line/_usage.mdx b/src/.gen/pages/01-reference/python/resources/log/log_line/_usage.mdx index 96ea29a..f79e863 100644 --- a/src/.gen/pages/01-reference/python/resources/log/log_line/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/log/log_line/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.log.log_line(level=operations.Level.FOUR, message='string', source='string') +res = s.log.log_line(level=operations.Level.TWO, message='Test log message', source='Postman') if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_header.mdx b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx index 929b020..5cbf752 100644 --- a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_parameters.mdx @@ -1,2 +1,4 @@ {/* Autogenerated DO NOT EDIT */} +##### `request` *{`str`}* +The request object to use for the request. diff --git a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx index abc5226..5b68810 100644 --- a/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/log/log_multi_line/_usage.mdx @@ -7,8 +7,11 @@ s = plex_api.PlexAPI( access_token="", ) +req = 'level=4&message=Test%20message%201&source=postman +level=3&message=Test%20message%202&source=postman +level=1&message=Test%20message%203&source=postman' -res = s.log.log_multi_line() +res = s.log.log_multi_line(req) if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx index f23a7d6..91562a8 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_parameters.mdx @@ -6,10 +6,10 @@ the ID of the playlist ##### `uri` *{`str`}* the content URI for the playlist
-**Example:** `library://..` +**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1` --- -##### `play_queue_id` *{`float`}* +##### `play_queue_id` *{`Optional[float]`}* the play queue to add to a playlist
**Example:** `123` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx index 4fd6429..3946ae0 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,9 +9,9 @@ s = plex_api.PlexAPI( ) -res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='library://..', play_queue_id=123) +res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,12 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx index 0a04198..7145344 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx @@ -10,13 +10,14 @@ s = plex_api.PlexAPI( req = operations.CreatePlaylistRequest( title='string', - type=operations.Type.PHOTO, - smart=operations.Smart.ZERO, + type=operations.Type.VIDEO, + smart=operations.Smart.ONE, + uri='http://velvety-spiderling.com', ) res = s.playlists.create_playlist(req) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -24,13 +25,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx index 41af0f3..cf53d74 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlist(playlist_id=6481.72) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx index 8b7bbc3..b8c549b 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,17 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx index d913ed6..1ba6a7b 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/get_playlists/_usage.mdx @@ -11,7 +11,7 @@ s = plex_api.PlexAPI( res = s.playlists.get_playlists(playlist_type=operations.PlaylistType.VIDEO, smart=operations.QueryParamSmart.ZERO) -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -19,13 +19,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx index 0d41902..148f489 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_parameters.mdx @@ -2,3 +2,11 @@ ##### `playlist_id` *{`float`}* the ID of the playlist +--- +##### `title` *{`Optional[str]`}* +name of the playlist + +--- +##### `summary` *{`Optional[str]`}* +summary description of the playlist + diff --git a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx index 80106f3..33b1607 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.update_playlist(playlist_id=3682.41) +res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string') if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx index c9f9981..f44f422 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force` *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/src/.gen/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx b/src/.gen/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx index 57c0800..8954af9 100644 --- a/src/.gen/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/server/get_available_clients/_usage.mdx @@ -10,34 +10,32 @@ s = plex_api.PlexAPI( res = s.server.get_available_clients() -if res.classes is not None: +if res.object is not None: # handle response pass ``` --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/src/.gen/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx b/src/.gen/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx index 873cb31..1620c7a 100644 --- a/src/.gen/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/server/get_server_preferences/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.server.get_server_preferences() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx b/src/.gen/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx index f92dcc5..a9917cf 100644 --- a/src/.gen/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/sessions/get_session_history/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.sessions.get_session_history() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx b/src/.gen/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx index e7eeaa6..b4a4e31 100644 --- a/src/.gen/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/sessions/get_sessions/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.sessions.get_sessions() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,10 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx b/src/.gen/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx index e3afa87..1eb9415 100644 --- a/src/.gen/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/sessions/get_transcode_sessions/_usage.mdx @@ -20,32 +20,7 @@ if res.object is not None: { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/src/.gen/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx b/src/.gen/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx index 0ff1f3b..d03930e 100644 --- a/src/.gen/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/updater/get_update_status/_usage.mdx @@ -10,7 +10,7 @@ s = plex_api.PlexAPI( res = s.updater.get_update_status() -if res.status_code == 200: +if res.object is not None: # handle response pass ``` @@ -18,13 +18,14 @@ if res.status_code == 200: ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx index 7412ed5..f78c603 100644 --- a/src/.gen/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/hubs/get_global_hubs/_usage.mdx @@ -24,13 +24,12 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 8, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx index 29c9858..875f903 100644 --- a/src/.gen/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/hubs/get_library_hubs/_usage.mdx @@ -25,13 +25,15 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "Hub": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx deleted file mode 100644 index bf652f4..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Common Library Items - -Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx deleted file mode 100644 index bc6ac2b..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_parameters.mdx +++ /dev/null @@ -1,20 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx deleted file mode 100644 index 3876875..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetCommonLibraryItemsResponse from "/content/types/models/operations/get_common_library_items_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx deleted file mode 100644 index 57e7ece..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/_usage.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - -```typescript GetCommonLibraryItems.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const sectionId = 5288.95; - const type = 4799.77; - const filter = "string"; - - const result = await sdk.library.getCommonLibraryItems(sectionId, type, filter); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx deleted file mode 100644 index a17dd2f..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetCommonLibraryItems from './get_common_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items_content.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_common_library_items/get_common_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx deleted file mode 100644 index 7522ae4..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Latest Library Items - -This endpoint will return a list of the latest library items filtered by the filter and type provided diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx deleted file mode 100644 index bc6ac2b..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_parameters.mdx +++ /dev/null @@ -1,20 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `sectionId`: *{`number`}* -the Id of the library to query - ---- -##### `type`: *{`number`}* -item type - ---- -##### `filter?`: *{`string`}* -the filter parameter - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx deleted file mode 100644 index 3e5ce52..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetLatestLibraryItemsResponse from "/content/types/models/operations/get_latest_library_items_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx deleted file mode 100644 index 1637805..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/_usage.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - -```typescript GetLatestLibraryItems.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const sectionId = 7917.25; - const type = 8121.69; - const filter = "string"; - - const result = await sdk.library.getLatestLibraryItems(sectionId, type, filter); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] - } -``` - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx deleted file mode 100644 index db52f93..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import GetLatestLibraryItems from './get_latest_library_items_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items_content.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items_content.mdx deleted file mode 100644 index d9eb087..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_latest_library_items/get_latest_library_items_content.mdx +++ /dev/null @@ -1,21 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Library* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library/_header.mdx index 9586004..dd3566e 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library/_header.mdx @@ -1,21 +1,41 @@ ## Get Library -Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: +## Library Details Endpoint -- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: - - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. - - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. - - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. -- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: - - `key`: This provides the root endpoint returning the actual media list for the type. - - `type`: This is the metadata type for the type (if a standard Plex type). - - `title`: The title for for the content of this type (e.g. "Movies"). -- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. - - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. - - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. - - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. - - `title`: The title for the filter. -- Each `Sort` object contains a description of the sort field. - - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). - - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. - - `title`: The title of the field. +This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself. + +The details include: + +### Directories +Organized into three categories: + +- **Primary Directories**: + - Used in some clients for quick access to media subsets (e.g., "All", "On Deck"). + - Most can be replicated via media queries. + - Customizable by users. + +- **Secondary Directories**: + - Marked with `secondary="1"`. + - Used in older clients for structured navigation. + +- **Special Directories**: + - Includes a "By Folder" entry for filesystem-based browsing. + - Contains an obsolete `search="1"` entry for on-the-fly search dialog creation. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `key`: Endpoint for the media list of this type. + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library/_usage.mdx index 728a85d..2c40f79 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library/_usage.mdx @@ -24,13 +24,23 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 29, + "allowSync": false, + "art": "/:/resources/movie-fanart.jpg", + "content": "secondary", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "viewGroup": "secondary", + "viewMode": 65592, + "Directory": [], + "Type": [], + "FieldType": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx index b118553..0cb92e7 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx @@ -1,3 +1,23 @@ ## Get Library Items -This endpoint will return a list of library items filtered by the filter and type provided +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. +- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx index e8e7ff8..4197fac 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_parameters.mdx @@ -1,14 +1,18 @@ {/* Autogenerated DO NOT EDIT */} +import Tag from "/content/types/models/operations/tag/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + ##### `sectionId`: *{`number`}* the Id of the library to query --- -##### `type?`: *{`number`}* -item type +##### `tag`: *{`operations.Tag`}* +A key representing a specific tag within the section. ---- -##### `filter?`: *{`string`}* -the filter parameter + + + --- ##### `options?`: *{`RequestOptions`}* diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx index 90eb6a3..66dea81 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx @@ -2,17 +2,17 @@ ```typescript GetLibraryItems.ts import { PlexAPI } from "@lukehagar/plexjs"; +import { Tag } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ accessToken: "", }); - const sectionId = 2726.56; - const type = 3834.41; - const filter = "string"; + const sectionId = 272656; + const tag = Tag.Edition; - const result = await sdk.library.getLibraryItems(sectionId, type, filter); + const result = await sdk.library.getLibraryItems(sectionId, tag); // Handle the result console.log(result) @@ -24,13 +24,23 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 70, + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "thumb": "/:/resources/movie.png", + "title1": "Movies", + "title2": "Recently Released", + "viewGroup": "movie", + "viewMode": 65592, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx index 411badf..7b72a58 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 5680.45; + const ratingKey = 7917.25; const result = await sdk.library.getMetadata(ratingKey); @@ -22,13 +22,17 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "allowSync": true, + "identifier": "com.plexapp.plugins.library", + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx index 1edcaf2..5a38d26 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 3927.85; + const ratingKey = 8121.69; const result = await sdk.library.getMetadataChildren(ratingKey); @@ -22,13 +22,31 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 3, + "allowSync": true, + "art": "/library/metadata/30072/art/1705739923", + "identifier": "com.plexapp.plugins.library", + "key": "30072", + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1701731894, + "nocache": true, + "parentIndex": 1, + "parentTitle": "Reacher", + "parentYear": 2022, + "summary": "When retired Military Police Officer Jack Reacher is arrested for a murder he did not commit, he finds himself in the middle of a deadly conspiracy full of dirty cops, shady businessmen, and scheming politicians. With nothing but his wits, he must figure out what is happening in Margrave, Georgia.", + "theme": "/library/metadata/30072/theme/1705739923", + "thumb": "/library/metadata/30072/thumb/1705739923", + "title1": "TV Shows", + "title2": "Reacher", + "viewGroup": "season", + "viewMode": 65593, + "Directory": [], + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx b/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx index 53d837f..47efd43 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx @@ -5,8 +5,6 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; -import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; -import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -24,8 +22,6 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/typescript/library/delete_library) - Delete Library Section * [Get Library Items](/typescript/library/get_library_items) - Get Library Items * [Refresh Library](/typescript/library/refresh_library) - Refresh Library -* [Get Latest Library Items](/typescript/library/get_latest_library_items) - Get Latest Library Items -* [Get Common Library Items](/typescript/library/get_common_library_items) - Get Common Library Items * [Get Metadata](/typescript/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/typescript/library/get_metadata_children) - Get Items Children * [Get On Deck](/typescript/library/get_on_deck) - Get On Deck @@ -51,12 +47,6 @@ API Calls interacting with Plex Media Server Libraries --- ---- - - ---- - - --- diff --git a/src/.gen/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx index f62878c..5f6f942 100644 --- a/src/.gen/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/log/log_line/_parameters.mdx @@ -7,7 +7,7 @@ import Labels from "/src/lib/labels"; An integer log level to write to the PMS log with. 0: Error 1: Warning -2: Info +2: Info 3: Debug 4: Verbose diff --git a/src/.gen/pages/01-reference/typescript/resources/log/log_line/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/log/log_line/_usage.mdx index c28b7a8..fa19a5e 100644 --- a/src/.gen/pages/01-reference/typescript/resources/log/log_line/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/log/log_line/_usage.mdx @@ -9,9 +9,9 @@ async function run() { accessToken: "", }); - const level = Level.Four; - const message = "string"; - const source = "string"; + const level = Level.Two; + const message = "Test log message"; + const source = "Postman"; const result = await sdk.log.logLine(level, message, source); diff --git a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx index 590e489..214068e 100644 --- a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_header.mdx @@ -1,3 +1,23 @@ ## Log Multi Line -This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. +This endpoint allows for the batch addition of log entries to the main Plex Media Server log. +It accepts a text/plain request body, where each line represents a distinct log entry. +Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. + +Log entries are separated by a newline character (`\n`). +Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. +This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. + +The 'level' parameter specifies the log entry's severity or importance, with the following integer values: +- `0`: Error - Critical issues that require immediate attention. +- `1`: Warning - Important events that are not critical but may indicate potential issues. +- `2`: Info - General informational messages about system operation. +- `3`: Debug - Detailed information useful for debugging purposes. +- `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. + +The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). + +Example of a single log entry format: +`level=4&message=Sample%20log%20entry&source=applicationName` + +Ensure each parameter is properly URL-encoded to avoid interpretation issues. diff --git a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx index d541e77..c503f99 100644 --- a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_parameters.mdx @@ -1,4 +1,8 @@ {/* Autogenerated DO NOT EDIT */} +##### `request`: *{`string`}* +The request object to use for the request. + +--- ##### `options?`: *{`RequestOptions`}* Options for making HTTP requests. diff --git a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx index 624e7d0..45a0066 100644 --- a/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/log/log_multi_line/_usage.mdx @@ -8,7 +8,9 @@ async function run() { accessToken: "", }); - const result = await sdk.log.logMultiLine(); + const result = await sdk.log.logMultiLine("level=4&message=Test%20message%201&source=postman + level=3&message=Test%20message%202&source=postman + level=1&message=Test%20message%203&source=postman"); // Handle the result console.log(result) diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx index 6f6d9c9..d14a46a 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_header.mdx @@ -1,4 +1,4 @@ ## Add Playlist Contents -Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx index ed9d0b2..de1686c 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_parameters.mdx @@ -9,7 +9,7 @@ the content URI for the playlist **Example:** `[object Object]` --- -##### `playQueueID`: *{`number`}* +##### `playQueueID?`: *{`number`}* the play queue to add to a playlist
**Example:** `[object Object]` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx index a42ac92..03a7b53 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ async function run() { }); const playlistID = 1403.5; - const uri = "library://.."; + const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1"; const playQueueID = 123; const result = await sdk.playlists.addPlaylistContents(playlistID, uri, playQueueID); @@ -24,13 +24,12 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "leafCountAdded": 1, + "leafCountRequested": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx index a10bc45..36b18bd 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_header.mdx @@ -1,5 +1,5 @@ ## Create Playlist Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: -- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `uri` - The content URI for what we're playing (e.g. `server://1234/com.plexapp.plugins.library/library/metadata/1`). - `playQueueID` - To create a playlist from an existing play queue. diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx index 75a183d..5e59556 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx @@ -11,8 +11,9 @@ async function run() { const result = await sdk.playlists.createPlaylist({ title: "string", - type: TypeT.Photo, - smart: Smart.Zero, + type: TypeT.Video, + smart: Smart.One, + uri: "http://velvety-spiderling.com", }); // Handle the result @@ -25,13 +26,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 7, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx index b5d0253..c9d23cb 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx @@ -22,13 +22,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx index 14d7199..217e38b 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx @@ -23,13 +23,17 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 2, + "composite": "/playlists/95/composite/1705717521", + "duration": 282, + "leafCount": 2, + "playlistType": "video", + "ratingKey": "95", + "smart": true, + "title": "Smart Movie Playlist", + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx index a01cf63..979b839 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlists/_usage.mdx @@ -24,13 +24,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 4, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx index 867032a..bafeab3 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_parameters.mdx @@ -2,6 +2,14 @@ ##### `playlistID`: *{`number`}* the ID of the playlist +--- +##### `title?`: *{`string`}* +name of the playlist + +--- +##### `summary?`: *{`string`}* +summary description of the playlist + --- ##### `options?`: *{`RequestOptions`}* Options for making HTTP requests. diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx index e358c01..9bcfad4 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx @@ -9,8 +9,10 @@ async function run() { }); const playlistID = 3682.41; + const title = "string"; + const summary = "string"; - const result = await sdk.playlists.updatePlaylist(playlistID); + const result = await sdk.playlists.updatePlaylist(playlistID, title, summary); // Handle the result console.log(result) diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx index 9a6b512..a115fd8 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/_parameters.mdx @@ -16,8 +16,10 @@ The GUID of each playlist is based on the filename. --- ##### `force`: *{`operations.Force`}* -force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. -The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. +Force overwriting of duplicate playlists. +By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. +If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. diff --git a/src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx index 96de98e..6b42615 100644 --- a/src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_usage.mdx @@ -19,27 +19,25 @@ run(); --- ```json Example Response - [ - { - "MediaContainer": { - "size": 1, - "Server": [ - { - "name": "iPad", - "host": "10.10.10.102", - "address": "10.10.10.102", - "port": 32500, - "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", - "version": "8.17", - "protocol": "plex", - "product": "Plex for iOS", - "deviceClass": "tablet", - "protocolVersion": 2, - "protocolCapabilities": "playback,playqueues,timeline,provider-playback" - } - ] - } + { + "MediaContainer": { + "size": 1, + "Server": [ + { + "name": "iPad", + "host": "10.10.10.102", + "address": "10.10.10.102", + "port": 32500, + "machineIdentifier": "A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05", + "version": "8.17", + "protocol": "plex", + "product": "Plex for iOS", + "deviceClass": "tablet", + "protocolVersion": 2, + "protocolCapabilities": "playback,playqueues,timeline,provider-playback" + } + ] } - ] + } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx index d82abc7..53975b2 100644 --- a/src/.gen/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/server/get_server_preferences/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 161, + "Setting": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx index 75a30c1..d13c6a6 100644 --- a/src/.gen/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/sessions/get_session_history/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 10855, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx index dd7adeb..b87deec 100644 --- a/src/.gen/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/sessions/get_sessions/_usage.mdx @@ -20,13 +20,10 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "Metadata": [] + } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx index 3d47287..180151f 100644 --- a/src/.gen/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/sessions/get_transcode_sessions/_usage.mdx @@ -22,32 +22,7 @@ run(); { "MediaContainer": { "size": 1, - "TranscodeSession": [ - { - "key": "zz7llzqlx8w9vnrsbnwhbmep", - "throttled": false, - "complete": false, - "progress": 0.4000000059604645, - "size": -22, - "speed": 22.399999618530273, - "error": false, - "duration": 2561768, - "context": "streaming", - "sourceVideoCodec": "h264", - "sourceAudioCodec": "ac3", - "videoDecision": "transcode", - "audioDecision": "transcode", - "protocol": "http", - "container": "mkv", - "videoCodec": "h264", - "audioCodec": "opus", - "audioChannels": 2, - "transcodeHwRequested": false, - "timeStamp": 1681869535.7764285, - "maxOffsetAvailable": 861.778, - "minOffsetAvailable": 0 - } - ] + "TranscodeSession": [] } } ``` diff --git a/src/.gen/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx index 5c98d8d..946b3d2 100644 --- a/src/.gen/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/updater/get_update_status/_usage.mdx @@ -20,13 +20,14 @@ run(); ```json Example Response { - "errors": [ - { - "code": 1001, - "message": "User could not be authenticated", - "status": 401 - } - ] + "MediaContainer": { + "size": 1, + "canInstall": false, + "checkedAt": 1705801232, + "downloadURL": "https://plex.tv/downloads/latest/5?channel=8&build=linux-x86_64&distro=redhat&X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", + "status": 0, + "Release": [] + } } ``` diff --git a/src/pages/curl/library/_meta.json b/src/pages/curl/library/_meta.json index 4fa4fb1..b0a6dbe 100644 --- a/src/pages/curl/library/_meta.json +++ b/src/pages/curl/library/_meta.json @@ -1,13 +1,13 @@ { + "delete_library": "Delete Library", + "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", + "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", - "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", - "get_latest_library_items": "Get Latest Library Items", - "get_common_library_items": "Get Common Library Items", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/go/library/_meta.json b/src/pages/go/library/_meta.json index 4fa4fb1..b0a6dbe 100644 --- a/src/pages/go/library/_meta.json +++ b/src/pages/go/library/_meta.json @@ -1,13 +1,13 @@ { + "delete_library": "Delete Library", + "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", + "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", - "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", - "get_latest_library_items": "Get Latest Library Items", - "get_common_library_items": "Get Common Library Items", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/python/library/_meta.json b/src/pages/python/library/_meta.json index 4fa4fb1..b0a6dbe 100644 --- a/src/pages/python/library/_meta.json +++ b/src/pages/python/library/_meta.json @@ -1,13 +1,13 @@ { + "delete_library": "Delete Library", + "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", + "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", - "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", - "get_latest_library_items": "Get Latest Library Items", - "get_common_library_items": "Get Common Library Items", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/typescript/library/_meta.json b/src/pages/typescript/library/_meta.json index 4fa4fb1..b0a6dbe 100644 --- a/src/pages/typescript/library/_meta.json +++ b/src/pages/typescript/library/_meta.json @@ -1,13 +1,13 @@ { + "delete_library": "Delete Library", + "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", + "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", - "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", - "get_latest_library_items": "Get Latest Library Items", - "get_common_library_items": "Get Common Library Items", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck"