ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0

This commit is contained in:
speakeasybot
2024-01-23 00:32:38 +00:00
parent 26c128571f
commit e044084015
954 changed files with 20504 additions and 4484 deletions

View File

@@ -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

View File

@@ -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
- 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

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetGlobalHubsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLibraryHubsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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: `<no value>`

View File

@@ -1,8 +0,0 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Common Library Items
<OperationInfo method='get' path='/library/sections/{sectionId}/common' />
Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter

View File

@@ -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

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"404"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

View File

@@ -1,21 +0,0 @@
<CH.Code>
```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
}
]
}
```
</CH.Code>

View File

@@ -1,12 +0,0 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Library*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

View File

@@ -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: `<no value>`

View File

@@ -1,8 +0,0 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Latest Library Items
<OperationInfo method='get' path='/library/sections/{sectionId}/latest' />
This endpoint will return a list of the latest library items filtered by the filter and type provided

View File

@@ -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

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

View File

@@ -1,21 +0,0 @@
<CH.Code>
```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
}
]
}
```
</CH.Code>

View File

@@ -1,12 +0,0 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Library*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

View File

@@ -4,23 +4,43 @@ import OperationInfo from '/src/components/OperationInfo';
<OperationInfo method='get' path='/library/sections/{sectionId}' />
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.

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLibraryMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -2,7 +2,27 @@ import OperationInfo from '/src/components/OperationInfo';
## Get Library Items
<OperationInfo method='get' path='/library/sections/{sectionId}/all' />
<OperationInfo method='get' path='/library/sections/{sectionId}/{tag}' />
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.

View File

@@ -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
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Tag />
</Collapsible>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLibraryItemsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetMetadataMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetMetadataChildrenMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -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
---
<RefreshLibrary />
---
<GetLatestLibraryItems />
---
<GetCommonLibraryItems />
---
<GetMetadata />

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -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.
<br/>
**Example:** `Test log message`
---
##### `source` _string_
a string indicating the source of the message.
<br/>
**Example:** `Postman`

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -4,5 +4,25 @@ import OperationInfo from '/src/components/OperationInfo';
<OperationInfo method='post' path='/log' />
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.

View File

@@ -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` __
<LogMultiLineRequestBody />

View File

@@ -4,6 +4,6 @@ import OperationInfo from '/src/components/OperationInfo';
<OperationInfo method='put' path='/playlists/{playlistID}/items' />
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.

View File

@@ -6,10 +6,10 @@ the ID of the playlist
##### `uri` _string_
the content URI for the playlist
<br/>
**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
<br/>
**Example:** `123`

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<AddPlaylistContentsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -5,6 +5,6 @@ import OperationInfo from '/src/components/OperationInfo';
<OperationInfo method='post' path='/playlists' />
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.

View File

@@ -24,7 +24,7 @@ whether the playlist is smart or not
</Collapsible>
---
##### `uri` _string (optional)_
##### `uri` _string_
the content URI for the playlist
---

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<CreatePlaylistMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetPlaylistMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetPlaylistContentsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -2,6 +2,6 @@ import OperationInfo from '/src/components/OperationInfo';
## Get Playlists
<OperationInfo method='get' path='/playlists/all' />
<OperationInfo method='get' path='/playlists' />
Get All Playlists given the specified filters.

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetPlaylistsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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": []
}
}
```
</CH.Code>

View File

@@ -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

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -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.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetAvailableClientsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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"
}
]
}
]
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetServerPreferencesMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetSessionHistoryMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetSessionsMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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": []
}
}
```

View File

@@ -7,7 +7,7 @@ import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
<Tab title={<StatusCode code={"204"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}

View File

@@ -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';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `MediaContainer` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetUpdateStatusMediaContainer/>
</Collapsible>
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -1,7 +1,7 @@
<CH.Code>
```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'
```

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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

View File

@@ -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

View File

@@ -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`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetCommonLibraryItemsResponse />
</Collapsible>
---
##### *{`error`}*

View File

@@ -1,50 +0,0 @@
<CH.Code>
```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("<YOUR_API_KEY_HERE>"),
)
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
}
]
}
```
</CH.Code>

View File

@@ -1,12 +0,0 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Library*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

View File

@@ -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

View File

@@ -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

View File

@@ -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`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetLatestLibraryItemsResponse />
</Collapsible>
---
##### *{`error`}*

View File

@@ -1,50 +0,0 @@
<CH.Code>
```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("<YOUR_API_KEY_HERE>"),
)
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
}
]
}
```
</CH.Code>

View File

@@ -1,12 +0,0 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Library*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

View File

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

View File

@@ -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": []
}
}
```
</CH.Code>

View File

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

View File

@@ -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
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Tag />
</Collapsible>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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
---
<RefreshLibrary />
---
<GetLatestLibraryItems />
---
<GetCommonLibraryItems />
---
<GetMetadata />

View File

@@ -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.
<br/>
**Example:** `Test log message`
---
##### `source` *{`string`}*
a string indicating the source of the message.
<br/>
**Example:** `Postman`

View File

@@ -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)

View File

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

View File

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

View File

@@ -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)
}

View File

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

View File

@@ -10,10 +10,10 @@ the ID of the playlist
##### `uri` *{`string`}*
the content URI for the playlist
<br/>
**Example:** `library://..`
**Example:** `server://12345/com.plexapp.plugins.library/library/metadata/1`
---
##### `playQueueID` *{`float64`}*
##### `playQueueID` *{`*float64`}*
the play queue to add to a playlist
<br/>
**Example:** `123`

View File

@@ -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": []
}
}
```
</CH.Code>

View File

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

View File

@@ -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": []
}
}
```
</CH.Code>

View File

@@ -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": []
}
}
```
</CH.Code>

Some files were not shown because too many files have changed in this diff Show More