diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index ff2dbe2..333a801 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,27 +1,29 @@ lockVersion: 2.0.0 id: 7fc33f51-d778-40ef-b094-90972c025d39 management: - docChecksum: 278d186496d83d5830ba4870f8cad39d + docChecksum: 911d74baa0d06121d2ce2c71d94e977a docVersion: 0.0.3 speakeasyVersion: internal - generationVersion: 2.269.0 - releaseVersion: 0.4.0 - configChecksum: 36a0bdf87b71fb5e9239da9afe59ff45 + generationVersion: 2.338.7 + releaseVersion: 0.5.0 + configChecksum: 7941086b27d718cdbb119fc22ed9f7c8 published: true features: docs: - constsAndDefaults: 0.1.0 - core: 1.26.2 + constsAndDefaults: 0.1.1 + core: 1.26.4 flattening: 0.1.0 - globalSecurity: 0.1.1 + globalSecurity: 0.1.4 globalServerURLs: 0.1.1 + globals: 0.2.1 methodServerURLs: 0.1.1 - nameOverrides: 0.1.0 + nameOverrides: 0.1.1 generatedFiles: - content/pages/01-reference/go/client_sdks/_snippet.mdx - content/pages/01-reference/go/client_sdks/client_sdks.mdx - content/pages/01-reference/go/custom_http_client/custom_http_client.mdx - content/pages/01-reference/go/errors/errors.mdx + - content/pages/01-reference/go/global_parameters/global_parameters.mdx - content/pages/01-reference/go/installation/installation.mdx - content/pages/01-reference/go/resources/activities/activities.mdx - content/pages/01-reference/go/resources/activities/cancel_server_activities/_header.mdx @@ -34,6 +36,17 @@ generatedFiles: - content/pages/01-reference/go/resources/activities/get_server_activities/_response.mdx - content/pages/01-reference/go/resources/activities/get_server_activities/_usage.mdx - content/pages/01-reference/go/resources/activities/get_server_activities/get_server_activities.mdx + - content/pages/01-reference/go/resources/authentication/authentication.mdx + - content/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx + - content/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx + - content/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx + - content/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx + - content/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - content/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx + - content/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx + - content/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx + - content/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx + - content/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx - content/pages/01-reference/go/resources/butler/butler.mdx - content/pages/01-reference/go/resources/butler/get_butler_tasks/_header.mdx - content/pages/01-reference/go/resources/butler/get_butler_tasks/_parameters.mdx @@ -232,17 +245,6 @@ generatedFiles: - content/pages/01-reference/go/resources/search/perform_voice_search/_usage.mdx - content/pages/01-reference/go/resources/search/perform_voice_search/perform_voice_search.mdx - content/pages/01-reference/go/resources/search/search.mdx - - content/pages/01-reference/go/resources/security/get_source_connection_information/_header.mdx - - content/pages/01-reference/go/resources/security/get_source_connection_information/_parameters.mdx - - content/pages/01-reference/go/resources/security/get_source_connection_information/_response.mdx - - content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx - - content/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information.mdx - - content/pages/01-reference/go/resources/security/get_transient_token/_header.mdx - - content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx - - content/pages/01-reference/go/resources/security/get_transient_token/_response.mdx - - content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx - - content/pages/01-reference/go/resources/security/get_transient_token/get_transient_token.mdx - - content/pages/01-reference/go/resources/security/security.mdx - content/pages/01-reference/go/resources/server/get_available_clients/_header.mdx - content/pages/01-reference/go/resources/server/get_available_clients/_parameters.mdx - content/pages/01-reference/go/resources/server/get_available_clients/_response.mdx @@ -344,6 +346,7 @@ generatedFiles: - content/pages/01-reference/python/client_sdks/client_sdks.mdx - content/pages/01-reference/python/custom_http_client/custom_http_client.mdx - content/pages/01-reference/python/errors/errors.mdx + - content/pages/01-reference/python/global_parameters/global_parameters.mdx - content/pages/01-reference/python/installation/installation.mdx - content/pages/01-reference/python/resources/activities/activities.mdx - content/pages/01-reference/python/resources/activities/cancel_server_activities/_header.mdx @@ -356,6 +359,17 @@ generatedFiles: - content/pages/01-reference/python/resources/activities/get_server_activities/_response.mdx - content/pages/01-reference/python/resources/activities/get_server_activities/_usage.mdx - content/pages/01-reference/python/resources/activities/get_server_activities/get_server_activities.mdx + - content/pages/01-reference/python/resources/authentication/authentication.mdx + - content/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx + - content/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx + - content/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx + - content/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx + - content/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - content/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx + - content/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx + - content/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx + - content/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx + - content/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx - content/pages/01-reference/python/resources/butler/butler.mdx - content/pages/01-reference/python/resources/butler/get_butler_tasks/_header.mdx - content/pages/01-reference/python/resources/butler/get_butler_tasks/_parameters.mdx @@ -554,17 +568,6 @@ generatedFiles: - content/pages/01-reference/python/resources/search/perform_voice_search/_usage.mdx - content/pages/01-reference/python/resources/search/perform_voice_search/perform_voice_search.mdx - content/pages/01-reference/python/resources/search/search.mdx - - content/pages/01-reference/python/resources/security/get_source_connection_information/_header.mdx - - content/pages/01-reference/python/resources/security/get_source_connection_information/_parameters.mdx - - content/pages/01-reference/python/resources/security/get_source_connection_information/_response.mdx - - content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx - - content/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information.mdx - - content/pages/01-reference/python/resources/security/get_transient_token/_header.mdx - - content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx - - content/pages/01-reference/python/resources/security/get_transient_token/_response.mdx - - content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx - - content/pages/01-reference/python/resources/security/get_transient_token/get_transient_token.mdx - - content/pages/01-reference/python/resources/security/security.mdx - content/pages/01-reference/python/resources/server/get_available_clients/_header.mdx - content/pages/01-reference/python/resources/server/get_available_clients/_parameters.mdx - content/pages/01-reference/python/resources/server/get_available_clients/_response.mdx @@ -666,6 +669,7 @@ generatedFiles: - content/pages/01-reference/typescript/client_sdks/client_sdks.mdx - content/pages/01-reference/typescript/custom_http_client/custom_http_client.mdx - content/pages/01-reference/typescript/errors/errors.mdx + - content/pages/01-reference/typescript/global_parameters/global_parameters.mdx - content/pages/01-reference/typescript/installation/installation.mdx - content/pages/01-reference/typescript/resources/activities/activities.mdx - content/pages/01-reference/typescript/resources/activities/cancel_server_activities/_header.mdx @@ -678,6 +682,17 @@ generatedFiles: - content/pages/01-reference/typescript/resources/activities/get_server_activities/_response.mdx - content/pages/01-reference/typescript/resources/activities/get_server_activities/_usage.mdx - content/pages/01-reference/typescript/resources/activities/get_server_activities/get_server_activities.mdx + - content/pages/01-reference/typescript/resources/authentication/authentication.mdx + - content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx + - content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx + - content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx + - content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx + - content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - content/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx + - content/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx + - content/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx + - content/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx + - content/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx - content/pages/01-reference/typescript/resources/butler/butler.mdx - content/pages/01-reference/typescript/resources/butler/get_butler_tasks/_header.mdx - content/pages/01-reference/typescript/resources/butler/get_butler_tasks/_parameters.mdx @@ -876,17 +891,6 @@ generatedFiles: - content/pages/01-reference/typescript/resources/search/perform_voice_search/_usage.mdx - content/pages/01-reference/typescript/resources/search/perform_voice_search/perform_voice_search.mdx - content/pages/01-reference/typescript/resources/search/search.mdx - - content/pages/01-reference/typescript/resources/security/get_source_connection_information/_header.mdx - - content/pages/01-reference/typescript/resources/security/get_source_connection_information/_parameters.mdx - - content/pages/01-reference/typescript/resources/security/get_source_connection_information/_response.mdx - - content/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx - - content/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information.mdx - - content/pages/01-reference/typescript/resources/security/get_transient_token/_header.mdx - - content/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx - - content/pages/01-reference/typescript/resources/security/get_transient_token/_response.mdx - - content/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx - - content/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token.mdx - - content/pages/01-reference/typescript/resources/security/security.mdx - content/pages/01-reference/typescript/resources/server/get_available_clients/_header.mdx - content/pages/01-reference/typescript/resources/server/get_available_clients/_parameters.mdx - content/pages/01-reference/typescript/resources/server/get_available_clients/_response.mdx @@ -984,6 +988,8 @@ generatedFiles: - content/pages/01-reference/typescript/resources/video/video.mdx - content/pages/01-reference/typescript/security_options/security_options.mdx - content/pages/01-reference/typescript/server_options/server_options.mdx + - content/types/models/components/http_metadata/go.mdx + - content/types/models/components/http_metadata/python.mdx - content/types/models/components/http_metadata/typescript.mdx - content/types/models/components/security/go.mdx - content/types/models/components/security/python.mdx @@ -1056,6 +1062,10 @@ 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 @@ -1184,6 +1194,10 @@ generatedFiles: - content/types/models/errors/refresh_library_errors/typescript.mdx - content/types/models/errors/refresh_library_response_body/python.mdx - content/types/models/errors/refresh_library_response_body/typescript.mdx + - content/types/models/errors/search_library_errors/python.mdx + - content/types/models/errors/search_library_errors/typescript.mdx + - content/types/models/errors/search_library_response_body/python.mdx + - content/types/models/errors/search_library_response_body/typescript.mdx - content/types/models/errors/start_all_tasks_errors/python.mdx - content/types/models/errors/start_all_tasks_errors/typescript.mdx - content/types/models/errors/start_all_tasks_response_body/python.mdx @@ -1220,6 +1234,7 @@ generatedFiles: - content/types/models/errors/upload_playlist_errors/typescript.mdx - content/types/models/errors/upload_playlist_response_body/python.mdx - content/types/models/errors/upload_playlist_response_body/typescript.mdx + - content/types/models/internal/globals/python.mdx - content/types/models/operations/account/go.mdx - content/types/models/operations/account/python.mdx - content/types/models/operations/account/typescript.mdx @@ -1571,6 +1586,9 @@ generatedFiles: - 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_pin_globals/go.mdx + - content/types/models/operations/get_pin_globals/python.mdx + - content/types/models/operations/get_pin_globals/typescript.mdx - content/types/models/operations/get_pin_request/go.mdx - content/types/models/operations/get_pin_request/python.mdx - content/types/models/operations/get_pin_request/typescript.mdx @@ -1802,6 +1820,9 @@ generatedFiles: - content/types/models/operations/get_timeline_response/go.mdx - content/types/models/operations/get_timeline_response/python.mdx - content/types/models/operations/get_timeline_response/typescript.mdx + - content/types/models/operations/get_token_globals/go.mdx + - content/types/models/operations/get_token_globals/python.mdx + - content/types/models/operations/get_token_globals/typescript.mdx - content/types/models/operations/get_token_request/go.mdx - content/types/models/operations/get_token_request/python.mdx - content/types/models/operations/get_token_request/typescript.mdx @@ -2097,6 +2118,8 @@ generatedFiles: - 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 @@ -2161,6 +2184,8 @@ generatedFiles: - content/types/models/sdkerrors/perform_voice_search_response_body/go.mdx - content/types/models/sdkerrors/refresh_library_errors/go.mdx - content/types/models/sdkerrors/refresh_library_response_body/go.mdx + - content/types/models/sdkerrors/search_library_errors/go.mdx + - content/types/models/sdkerrors/search_library_response_body/go.mdx - content/types/models/sdkerrors/start_all_tasks_errors/go.mdx - content/types/models/sdkerrors/start_all_tasks_response_body/go.mdx - content/types/models/sdkerrors/start_task_errors/go.mdx @@ -2492,19 +2517,19 @@ generatedFiles: - content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx - content/pages/01-reference/curl/resources/playlists/upload_playlist/_usage.mdx - content/pages/01-reference/curl/resources/playlists/upload_playlist/_header.mdx - - content/pages/01-reference/curl/resources/security/security.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx - - content/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx - - content/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx + - content/pages/01-reference/curl/resources/authentication/authentication.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx + - content/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx + - content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx - content/pages/01-reference/curl/resources/statistics/statistics.mdx - content/pages/01-reference/curl/resources/statistics/get_statistics/get_statistics.mdx - content/pages/01-reference/curl/resources/statistics/get_statistics/_authentication.mdx @@ -2748,6 +2773,8 @@ generatedFiles: - 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_library_response_body/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 @@ -2765,6 +2792,8 @@ generatedFiles: - content/types/operations/refresh_library_response/curl.mdx - content/types/operations/type/curl.mdx - content/types/operations/search_library_request/curl.mdx + - content/types/operations/search_library_errors/curl.mdx + - content/types/operations/search_library_library_response_body/curl.mdx - content/types/operations/search_library_metadata/curl.mdx - content/types/operations/search_library_media_container/curl.mdx - content/types/operations/search_library_response_body/curl.mdx @@ -3080,6 +3109,9 @@ generatedFiles: - src/.gen/pages/01-reference/python/errors/_snippet.mdx - src/.gen/pages/01-reference/python/errors/errors.mdx - src/.gen/pages/01-reference/python/errors/errors_content.mdx + - src/.gen/pages/01-reference/python/global_parameters/_snippet.mdx + - src/.gen/pages/01-reference/python/global_parameters/global_parameters.mdx + - src/.gen/pages/01-reference/python/global_parameters/global_parameters_content.mdx - src/.gen/pages/01-reference/python/installation/_snippet.mdx - src/.gen/pages/01-reference/python/installation/installation.mdx - src/.gen/pages/01-reference/python/installation/installation_content.mdx @@ -3097,6 +3129,20 @@ generatedFiles: - src/.gen/pages/01-reference/python/resources/activities/get_server_activities/get_server_activities_content.mdx - src/.gen/pages/01-reference/python/resources/activities/activities.mdx - src/.gen/pages/01-reference/python/resources/activities/activities_content.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx + - src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token_content.mdx + - src/.gen/pages/01-reference/python/resources/authentication/authentication.mdx + - src/.gen/pages/01-reference/python/resources/authentication/authentication_content.mdx - src/.gen/pages/01-reference/python/resources/butler/get_butler_tasks/_header.mdx - src/.gen/pages/01-reference/python/resources/butler/get_butler_tasks/_parameters.mdx - src/.gen/pages/01-reference/python/resources/butler/get_butler_tasks/_response.mdx @@ -3341,20 +3387,6 @@ generatedFiles: - src/.gen/pages/01-reference/python/resources/search/perform_voice_search/perform_voice_search_content.mdx - src/.gen/pages/01-reference/python/resources/search/search.mdx - src/.gen/pages/01-reference/python/resources/search/search_content.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_header.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_parameters.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_response.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information.mdx - - src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information_content.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/_header.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/_response.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token.mdx - - src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token_content.mdx - - src/.gen/pages/01-reference/python/resources/security/security.mdx - - src/.gen/pages/01-reference/python/resources/security/security_content.mdx - src/.gen/pages/01-reference/python/resources/server/get_available_clients/_header.mdx - src/.gen/pages/01-reference/python/resources/server/get_available_clients/_parameters.mdx - src/.gen/pages/01-reference/python/resources/server/get_available_clients/_response.mdx @@ -3486,12 +3518,16 @@ generatedFiles: - src/pages/python/client_sdks/_meta.json - src/pages/python/custom_http_client/_meta.json - src/pages/python/errors/_meta.json + - src/pages/python/global_parameters/_meta.json - src/pages/python/installation/_meta.json - src/pages/python/security_options/_meta.json - src/pages/python/server_options/_meta.json - src/pages/python/activities/cancel_server_activities/_meta.json - src/pages/python/activities/get_server_activities/_meta.json - src/pages/python/activities/_meta.json + - src/pages/python/authentication/get_source_connection_information/_meta.json + - src/pages/python/authentication/get_transient_token/_meta.json + - src/pages/python/authentication/_meta.json - src/pages/python/butler/get_butler_tasks/_meta.json - src/pages/python/butler/start_all_tasks/_meta.json - src/pages/python/butler/start_task/_meta.json @@ -3533,17 +3569,11 @@ generatedFiles: - src/pages/python/playlists/_meta.json - src/pages/python/plex/get_pin/_meta.json - src/pages/python/plex/get_token/_meta.json - - src/pages/python/plex/tv/get_pin/_meta.json - - src/pages/python/plex/tv/get_token/_meta.json - - src/pages/python/plex/tv/_meta.json - src/pages/python/plex/_meta.json - src/pages/python/search/get_search_results/_meta.json - src/pages/python/search/perform_search/_meta.json - src/pages/python/search/perform_voice_search/_meta.json - src/pages/python/search/_meta.json - - src/pages/python/security/get_source_connection_information/_meta.json - - src/pages/python/security/get_transient_token/_meta.json - - src/pages/python/security/_meta.json - src/pages/python/server/get_available_clients/_meta.json - src/pages/python/server/get_devices/_meta.json - src/pages/python/server/get_my_plex_account/_meta.json @@ -3578,6 +3608,9 @@ generatedFiles: - src/.gen/pages/01-reference/typescript/errors/_snippet.mdx - src/.gen/pages/01-reference/typescript/errors/errors.mdx - src/.gen/pages/01-reference/typescript/errors/errors_content.mdx + - src/.gen/pages/01-reference/typescript/global_parameters/_snippet.mdx + - src/.gen/pages/01-reference/typescript/global_parameters/global_parameters.mdx + - src/.gen/pages/01-reference/typescript/global_parameters/global_parameters_content.mdx - src/.gen/pages/01-reference/typescript/installation/_snippet.mdx - src/.gen/pages/01-reference/typescript/installation/installation.mdx - src/.gen/pages/01-reference/typescript/installation/installation_content.mdx @@ -3595,6 +3628,20 @@ generatedFiles: - src/.gen/pages/01-reference/typescript/resources/activities/get_server_activities/get_server_activities_content.mdx - src/.gen/pages/01-reference/typescript/resources/activities/activities.mdx - src/.gen/pages/01-reference/typescript/resources/activities/activities_content.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token_content.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/authentication.mdx + - src/.gen/pages/01-reference/typescript/resources/authentication/authentication_content.mdx - src/.gen/pages/01-reference/typescript/resources/butler/get_butler_tasks/_header.mdx - src/.gen/pages/01-reference/typescript/resources/butler/get_butler_tasks/_parameters.mdx - src/.gen/pages/01-reference/typescript/resources/butler/get_butler_tasks/_response.mdx @@ -3839,20 +3886,6 @@ generatedFiles: - src/.gen/pages/01-reference/typescript/resources/search/perform_voice_search/perform_voice_search_content.mdx - src/.gen/pages/01-reference/typescript/resources/search/search.mdx - src/.gen/pages/01-reference/typescript/resources/search/search_content.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_header.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_parameters.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_response.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information_content.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_header.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_response.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token.mdx - - src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token_content.mdx - - src/.gen/pages/01-reference/typescript/resources/security/security.mdx - - src/.gen/pages/01-reference/typescript/resources/security/security_content.mdx - src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_header.mdx - src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_parameters.mdx - src/.gen/pages/01-reference/typescript/resources/server/get_available_clients/_response.mdx @@ -3984,12 +4017,16 @@ generatedFiles: - src/pages/typescript/client_sdks/_meta.json - src/pages/typescript/custom_http_client/_meta.json - src/pages/typescript/errors/_meta.json + - src/pages/typescript/global_parameters/_meta.json - src/pages/typescript/installation/_meta.json - src/pages/typescript/security_options/_meta.json - src/pages/typescript/server_options/_meta.json - src/pages/typescript/activities/cancel_server_activities/_meta.json - src/pages/typescript/activities/get_server_activities/_meta.json - src/pages/typescript/activities/_meta.json + - src/pages/typescript/authentication/get_source_connection_information/_meta.json + - src/pages/typescript/authentication/get_transient_token/_meta.json + - src/pages/typescript/authentication/_meta.json - src/pages/typescript/butler/get_butler_tasks/_meta.json - src/pages/typescript/butler/start_all_tasks/_meta.json - src/pages/typescript/butler/start_task/_meta.json @@ -4031,17 +4068,11 @@ generatedFiles: - src/pages/typescript/playlists/_meta.json - src/pages/typescript/plex/get_pin/_meta.json - src/pages/typescript/plex/get_token/_meta.json - - src/pages/typescript/plex/tv/get_pin/_meta.json - - src/pages/typescript/plex/tv/get_token/_meta.json - - src/pages/typescript/plex/tv/_meta.json - src/pages/typescript/plex/_meta.json - src/pages/typescript/search/get_search_results/_meta.json - src/pages/typescript/search/perform_search/_meta.json - src/pages/typescript/search/perform_voice_search/_meta.json - src/pages/typescript/search/_meta.json - - src/pages/typescript/security/get_source_connection_information/_meta.json - - src/pages/typescript/security/get_transient_token/_meta.json - - src/pages/typescript/security/_meta.json - src/pages/typescript/server/get_available_clients/_meta.json - src/pages/typescript/server/get_devices/_meta.json - src/pages/typescript/server/get_my_plex_account/_meta.json @@ -4076,6 +4107,9 @@ generatedFiles: - src/.gen/pages/01-reference/go/errors/_snippet.mdx - src/.gen/pages/01-reference/go/errors/errors.mdx - src/.gen/pages/01-reference/go/errors/errors_content.mdx + - src/.gen/pages/01-reference/go/global_parameters/_snippet.mdx + - src/.gen/pages/01-reference/go/global_parameters/global_parameters.mdx + - src/.gen/pages/01-reference/go/global_parameters/global_parameters_content.mdx - src/.gen/pages/01-reference/go/installation/_snippet.mdx - src/.gen/pages/01-reference/go/installation/installation.mdx - src/.gen/pages/01-reference/go/installation/installation_content.mdx @@ -4093,6 +4127,20 @@ generatedFiles: - src/.gen/pages/01-reference/go/resources/activities/get_server_activities/get_server_activities_content.mdx - src/.gen/pages/01-reference/go/resources/activities/activities.mdx - src/.gen/pages/01-reference/go/resources/activities/activities_content.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx + - src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token_content.mdx + - src/.gen/pages/01-reference/go/resources/authentication/authentication.mdx + - src/.gen/pages/01-reference/go/resources/authentication/authentication_content.mdx - src/.gen/pages/01-reference/go/resources/butler/get_butler_tasks/_header.mdx - src/.gen/pages/01-reference/go/resources/butler/get_butler_tasks/_parameters.mdx - src/.gen/pages/01-reference/go/resources/butler/get_butler_tasks/_response.mdx @@ -4337,20 +4385,6 @@ generatedFiles: - src/.gen/pages/01-reference/go/resources/search/perform_voice_search/perform_voice_search_content.mdx - src/.gen/pages/01-reference/go/resources/search/search.mdx - src/.gen/pages/01-reference/go/resources/search/search_content.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_header.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_parameters.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_response.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information.mdx - - src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information_content.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/_header.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/_response.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token.mdx - - src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token_content.mdx - - src/.gen/pages/01-reference/go/resources/security/security.mdx - - src/.gen/pages/01-reference/go/resources/security/security_content.mdx - src/.gen/pages/01-reference/go/resources/server/get_available_clients/_header.mdx - src/.gen/pages/01-reference/go/resources/server/get_available_clients/_parameters.mdx - src/.gen/pages/01-reference/go/resources/server/get_available_clients/_response.mdx @@ -4482,12 +4516,16 @@ generatedFiles: - src/pages/go/client_sdks/_meta.json - src/pages/go/custom_http_client/_meta.json - src/pages/go/errors/_meta.json + - src/pages/go/global_parameters/_meta.json - src/pages/go/installation/_meta.json - src/pages/go/security_options/_meta.json - src/pages/go/server_options/_meta.json - src/pages/go/activities/cancel_server_activities/_meta.json - src/pages/go/activities/get_server_activities/_meta.json - src/pages/go/activities/_meta.json + - src/pages/go/authentication/get_source_connection_information/_meta.json + - src/pages/go/authentication/get_transient_token/_meta.json + - src/pages/go/authentication/_meta.json - src/pages/go/butler/get_butler_tasks/_meta.json - src/pages/go/butler/start_all_tasks/_meta.json - src/pages/go/butler/start_task/_meta.json @@ -4529,17 +4567,11 @@ generatedFiles: - src/pages/go/playlists/_meta.json - src/pages/go/plex/get_pin/_meta.json - src/pages/go/plex/get_token/_meta.json - - src/pages/go/plex/tv/get_pin/_meta.json - - src/pages/go/plex/tv/get_token/_meta.json - - src/pages/go/plex/tv/_meta.json - src/pages/go/plex/_meta.json - src/pages/go/search/get_search_results/_meta.json - src/pages/go/search/perform_search/_meta.json - src/pages/go/search/perform_voice_search/_meta.json - src/pages/go/search/_meta.json - - src/pages/go/security/get_source_connection_information/_meta.json - - src/pages/go/security/get_transient_token/_meta.json - - src/pages/go/security/_meta.json - src/pages/go/server/get_available_clients/_meta.json - src/pages/go/server/get_devices/_meta.json - src/pages/go/server/get_my_plex_account/_meta.json @@ -4584,6 +4616,22 @@ generatedFiles: - src/.gen/pages/01-reference/curl/resources/activities/get_server_activities/get_server_activities_content.mdx - src/.gen/pages/01-reference/curl/resources/activities/activities.mdx - src/.gen/pages/01-reference/curl/resources/activities/activities_content.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token_content.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/authentication.mdx + - src/.gen/pages/01-reference/curl/resources/authentication/authentication_content.mdx - src/.gen/pages/01-reference/curl/resources/butler/get_butler_tasks/_authentication.mdx - src/.gen/pages/01-reference/curl/resources/butler/get_butler_tasks/_header.mdx - src/.gen/pages/01-reference/curl/resources/butler/get_butler_tasks/_parameters.mdx @@ -4866,22 +4914,6 @@ generatedFiles: - src/.gen/pages/01-reference/curl/resources/search/perform_voice_search/perform_voice_search_content.mdx - src/.gen/pages/01-reference/curl/resources/search/search.mdx - src/.gen/pages/01-reference/curl/resources/search/search_content.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information_content.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx - - src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token_content.mdx - - src/.gen/pages/01-reference/curl/resources/security/security.mdx - - src/.gen/pages/01-reference/curl/resources/security/security_content.mdx - src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_authentication.mdx - src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_header.mdx - src/.gen/pages/01-reference/curl/resources/server/get_available_clients/_parameters.mdx @@ -5026,6 +5058,9 @@ generatedFiles: - src/pages/curl/activities/cancel_server_activities/_meta.json - src/pages/curl/activities/get_server_activities/_meta.json - src/pages/curl/activities/_meta.json + - src/pages/curl/authentication/get_source_connection_information/_meta.json + - src/pages/curl/authentication/get_transient_token/_meta.json + - src/pages/curl/authentication/_meta.json - src/pages/curl/butler/get_butler_tasks/_meta.json - src/pages/curl/butler/start_all_tasks/_meta.json - src/pages/curl/butler/start_task/_meta.json @@ -5067,9 +5102,6 @@ generatedFiles: - src/pages/curl/playlists/_meta.json - src/pages/curl/plex/get_pin/_meta.json - src/pages/curl/plex/get_token/_meta.json - - src/pages/curl/plex/tv/get_pin/_meta.json - - src/pages/curl/plex/tv/get_token/_meta.json - - src/pages/curl/plex/tv/_meta.json - src/pages/curl/plex/_meta.json - src/pages/curl/search/get_search_results/_meta.json - src/pages/curl/search/perform_search/_meta.json diff --git a/RELEASES.md b/RELEASES.md index 74d1328..c685358 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -52,4 +52,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 0.0.3 -- Speakeasy CLI 1.193.0 (2.269.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.193.0 (2.269.0) https://github.com/speakeasy-api/speakeasy + +## 2024-05-31 00:30:17 +### Changes +Based on: +- OpenAPI Doc 0.0.3 +- Speakeasy CLI 1.299.3 (2.338.7) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx index 6760e88..8ae9996 100644 --- a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx @@ -1,4 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `activityUUID` _string_ The UUID of the activity to cancel. +
+**Example:** `25b71ed5-0f9d-461c-baa7-d404e9e10d3e` diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx index a184747..789d656 100644 --- a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/activities/ \ +curl http://10.10.10.47:32400/activities/25b71ed5-0f9d-461c-baa7-d404e9e10d3e \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/authentication/authentication.mdx b/content/pages/01-reference/curl/resources/authentication/authentication.mdx new file mode 100644 index 0000000..43dba8e --- /dev/null +++ b/content/pages/01-reference/curl/resources/authentication/authentication.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/curl/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/curl/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx similarity index 76% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx index 52e3e0d..a602e36 100644 --- a/content/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx +++ b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/security/resources?source=server%3A%2F%2Fclient-identifier \ +curl http://10.10.10.47:32400/security/resources?source=provider%3A%2F%2Fprovider-identifier \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 91% rename from content/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx rename to content/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx index 424157e..c4b35e7 100644 --- a/content/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx +++ b/content/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Security* +###### *Authentication* } diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx similarity index 100% rename from content/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx b/content/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 91% rename from content/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx rename to content/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx index 424157e..c4b35e7 100644 --- a/content/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx +++ b/content/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Security* +###### *Authentication* } diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx index 82d2f40..f44dda6 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs?count=8121.69 \ +curl http://10.10.10.47:32400/hubs?count=7151.9 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -13,7 +13,41 @@ curl http://10.10.10.47:32400/hubs?count=8121.69 \ "size": 8, "allowSync": true, "identifier": "com.plexapp.plugins.library", - "Hub": [] + "Hub": [ + { + "hubKey": "/library/metadata/50768,65523,58188,57341,57302,57070", + "key": "/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio", + "title": "Recent Playlists", + "type": "playlist", + "hubIdentifier": "home.playlists", + "context": "hub.home.playlists", + "size": 6, + "more": true, + "style": "shelf", + "promoted": true, + "Metadata": [ + { + "ratingKey": "57070", + "key": "/playlists/57070/items", + "guid": "com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c", + "type": "playlist", + "title": "November Movie Day", + "titleSort": "Tracks", + "summary": "", + "smart": false, + "playlistType": "video", + "composite": "/playlists/57070/composite/1668787730", + "icon": "playlist://image.smart", + "viewCount": 2, + "lastViewedAt": 1668787732, + "duration": 16873000, + "leafCount": 3, + "addedAt": 1668779618, + "updatedAt": 1668787730 + } + ] + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx index 425d666..5ef05b4 100644 --- a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \ +curl http://10.10.10.47:32400/hubs/sections/8442.66?count=6027.63 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -16,7 +16,112 @@ curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \ "librarySectionID": 1, "librarySectionTitle": "Movies", "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", - "Hub": [] + "Hub": [ + { + "key": "/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0", + "title": "Recently Played Movies", + "type": "movie", + "hubIdentifier": "movie.recentlyviewed.1", + "context": "hub.movie.recentlyviewed", + "size": 6, + "more": true, + "style": "shelf", + "hubKey": "/library/metadata/66485,66098,57249,11449,5858,14944", + "Metadata": [ + { + "ratingKey": "14944", + "key": "/library/metadata/14944", + "guid": "plex://movie/5d77686eeb5d26001f1eb339", + "studio": "Walt Disney Animation Studios", + "type": "movie", + "title": "Tangled", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG", + "summary": "The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.", + "rating": 8.9, + "audienceRating": 8.7, + "viewCount": 1, + "lastViewedAt": 1704936047, + "year": 2010, + "tagline": "They're taking adventure to new lengths.", + "thumb": "/library/metadata/14944/thumb/1705739847", + "art": "/library/metadata/14944/art/1705739847", + "duration": 6017237, + "originallyAvailableAt": "2010-11-24T00:00:00Z", + "addedAt": 1589412494, + "updatedAt": 1705739847, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "primaryExtraKey": "/library/metadata/14952", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 38247, + "duration": 6017237, + "bitrate": 2051, + "width": 1920, + "height": 1080, + "aspectRatio": 1.78, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 1, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 38247, + "key": "/library/parts/38247/1589412494/file.mp4", + "duration": 6017237, + "file": "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4", + "size": 1545647447, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": true, + "videoProfile": "high" + } + ] + } + ], + "Genre": [ + { + "tag": "Animation" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "Nathan Greno" + } + ], + "Role": [ + { + "tag": "Donna Murphy" + } + ], + "Writer": [ + { + "tag": "Wilhelm Grimm" + } + ], + "skipCount": 1, + "chapterSource": "media" + } + ], + "promoted": true, + "random": true + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx index c890260..cd99312 100644 --- a/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/hashes?type=8360.79&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \ +curl http://10.10.10.47:32400/library/hashes?type=4236.55&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx index ffa713f..2214097 100644 --- a/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx @@ -13,7 +13,36 @@ curl http://10.10.10.47:32400/library/sections \ "size": 5, "allowSync": false, "title1": "Plex Library", - "Directory": [] + "Directory": [ + { + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "composite": "/library/sections/1/composite/1705615584", + "filters": true, + "refreshing": false, + "thumb": "/:/resources/movie.png", + "key": "1", + "type": "movie", + "title": "Movies", + "agent": "tv.plex.agents.movie", + "scanner": "Plex Movie", + "language": "en-US", + "uuid": "322a231a-b7f7-49f5-920f-14c61199cd30", + "updatedAt": 1705615634, + "createdAt": 1654131312, + "scannedAt": 1705615584, + "content": true, + "directory": true, + "contentChangedAt": 3192854, + "hidden": 0, + "Location": [ + { + "id": 1, + "path": "/movies" + } + ] + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx index 9678365..32320a7 100644 --- a/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx @@ -22,9 +22,61 @@ curl http://10.10.10.47:32400/library/sections/1000 \ "title1": "Movies", "viewGroup": "secondary", "viewMode": 65592, - "Directory": [], - "Type": [], - "FieldType": [] + "Directory": [ + { + "key": "search?type=1", + "title": "Search...", + "secondary": true, + "prompt": "Search Movies", + "search": true + } + ], + "Type": [ + { + "key": "/library/sections/1/all?type=1", + "type": "movie", + "title": "Movies", + "active": false, + "Filter": [ + { + "filter": "label", + "filterType": "string", + "key": "/library/sections/1/label", + "title": "Labels", + "type": "filter" + } + ], + "Sort": [ + { + "default": "asc", + "defaultDirection": "desc", + "descKey": "random:desc", + "firstCharacterKey": "/library/sections/1/firstCharacter", + "key": "random", + "title": "Randomly" + } + ], + "Field": [ + { + "key": "label", + "title": "Label", + "type": "tag", + "subType": "bitrate" + } + ] + } + ], + "FieldType": [ + { + "type": "resolution", + "Operator": [ + { + "key": "=", + "title": "is" + } + ] + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx index 56fb06d..f68c041 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx @@ -5,6 +5,8 @@ import Labels from "/src/lib/labels"; ##### `sectionId` _integer_ the Id of the library to query +
+**Example:** `1` --- ##### `tag` _enumeration_ diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx index b2b7df3..301ed60 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx @@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index 5fc5a2c..dfd44ad 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \ +curl http://10.10.10.47:32400/library/sections/1/{{tag}} \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -25,7 +25,114 @@ curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \ "viewGroup": "movie", "viewMode": 65592, "mixedParents": true, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "58683", + "key": "/library/metadata/58683", + "guid": "plex://movie/5d7768ba96b655001fdc0408", + "studio": "20th Century Studios", + "type": "movie", + "title": "Avatar: The Way of Water", + "contentRating": "PG-13", + "summary": "Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.", + "rating": 7.6, + "audienceRating": 9.2, + "year": 2022, + "tagline": "Return to Pandora.", + "thumb": "/library/metadata/58683/thumb/1703239236", + "art": "/library/metadata/58683/art/1703239236", + "duration": 11558112, + "originallyAvailableAt": "2022-12-14T00:00:00Z", + "addedAt": 1680457607, + "updatedAt": 1703239236, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "chapterSource": "media", + "primaryExtraKey": "/library/metadata/58684", + "ratingImage": "rottentomatoes://image.rating.ripe", + "grandparentRatingKey": "66", + "grandparentGuid": "plex://show/5d9c081b170e24001f2a7be4", + "grandparentKey": "/library/metadata/66", + "grandparentTitle": "Caprica", + "grandparentThumb": "/library/metadata/66/thumb/1705716261", + "grandparentArt": "/library/metadata/66/art/1705716261", + "grandparentTheme": "/library/metadata/66/theme/1705716261", + "Media": [ + { + "id": 119534, + "duration": 11558112, + "bitrate": 25025, + "width": 3840, + "height": 2072, + "aspectRatio": 1.85, + "audioChannels": 6, + "audioCodec": "eac3", + "videoCodec": "hevc", + "videoResolution": "4k", + "container": "mkv", + "videoFrameRate": "24p", + "videoProfile": "main 10", + "Part": [ + { + "id": 119542, + "key": "/library/parts/119542/1680457526/file.mkv", + "duration": 11558112, + "file": "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv", + "size": 36158371307, + "container": "mkv", + "videoProfile": "main 10" + } + ] + } + ], + "Genre": [ + { + "tag": "Adventure" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "James Cameron" + } + ], + "Writer": [ + { + "tag": "James Cameron" + } + ], + "Role": [ + { + "tag": "Sigourney Weaver" + } + ], + "titleSort": "Whale", + "viewCount": 1, + "lastViewedAt": 1682752242, + "originalTitle": "映画 ブラッククローバー 魔法帝の剣", + "viewOffset": 5222500, + "skipCount": 1, + "index": 1, + "theme": "/library/metadata/1/theme/1705636920", + "leafCount": 14, + "viewedLeafCount": 0, + "childCount": 1, + "hasPremiumExtras": "1", + "hasPremiumPrimaryExtra": "1", + "parentRatingKey": "66", + "parentGuid": "plex://show/5d9c081b170e24001f2a7be4", + "parentStudio": "UCP", + "parentKey": "/library/metadata/66", + "parentTitle": "Caprica", + "parentIndex": 1, + "parentYear": 2010, + "parentThumb": "/library/metadata/66/thumb/1705716261", + "parentTheme": "/library/metadata/66/theme/1705716261" + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 33a3cd7..4a606a1 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/6481.72 \ +curl http://10.10.10.47:32400/library/metadata/3843.82 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -18,7 +18,167 @@ curl http://10.10.10.47:32400/library/metadata/6481.72 \ "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", "mediaTagPrefix": "/system/bundle/media/flags/", "mediaTagVersion": 1698860922, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "17", + "key": "/library/metadata/17", + "guid": "plex://movie/5d77683f6f4521001ea9dc53", + "studio": "Universal Pictures", + "type": "movie", + "title": "Serenity", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG-13", + "summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.", + "rating": 8.2, + "audienceRating": 9.1, + "year": 2005, + "tagline": "They aim to misbehave.", + "thumb": "/library/metadata/17/thumb/1705637165", + "art": "/library/metadata/17/art/1705637165", + "duration": 141417, + "originallyAvailableAt": "2005-09-29T00:00:00Z", + "addedAt": 1705637164, + "updatedAt": 1705637165, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "hasPremiumPrimaryExtra": "1", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 15, + "duration": 141417, + "bitrate": 2278, + "width": 1920, + "height": 814, + "aspectRatio": 2.35, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 0, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 15, + "key": "/library/parts/15/1705637151/file.mp4", + "duration": 141417, + "file": "/movies/Serenity (2005)/Serenity (2005).mp4", + "size": 40271948, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": false, + "videoProfile": "high", + "Stream": [ + { + "id": 29, + "streamType": 2, + "default": true, + "codec": "aac", + "index": 0, + "bitrate": 128, + "bitDepth": 8, + "chromaLocation": "left", + "chromaSubsampling": "14520", + "codedHeight": 816, + "codedWidth": 1920, + "colorPrimaries": "bt709", + "colorRange": "tv", + "colorSpace": "bt709", + "colorTrc": "bt709", + "frameRate": 24, + "hasScalingMatrix": false, + "height": 814, + "level": 40, + "profile": "lc", + "refFrames": 4, + "scanType": "progressive", + "streamIdentifier": "1", + "width": 1920, + "displayTitle": "English (AAC Stereo)", + "extendedDisplayTitle": "English (AAC Stereo)", + "selected": true, + "channels": 2, + "language": "English", + "languageTag": "en", + "languageCode": "eng", + "samplingRate": 44100 + } + ] + } + ] + } + ], + "Genre": [ + { + "id": 184, + "filter": "genre=184", + "tag": "Thriller" + } + ], + "Country": [ + { + "id": 116, + "filter": "country=116", + "tag": "United States of America" + } + ], + "guids": [ + { + "id": "tvdb://2337" + } + ], + "ratings": [ + { + "image": "themoviedb://image.rating", + "value": 7.4, + "type": "audience" + } + ], + "Director": [ + { + "id": 130, + "filter": "director=130", + "tag": "Joss Whedon", + "tagKey": "5d776828880197001ec90e8f", + "thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg" + } + ], + "Writer": [ + { + "id": 132, + "filter": "writer=132", + "tag": "Joss Whedon", + "tagKey": "5d776828880197001ec90e8f", + "thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg" + } + ], + "Role": [ + { + "id": 220, + "filter": "actor=220", + "tag": "Dennis Keiffer", + "tagKey": "5d77683554f42c001f8c4708", + "role": "Bar Guy (uncredited)", + "thumb": "https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg" + } + ], + "Producer": [ + { + "id": 221, + "filter": "producer=221", + "tag": "Barry Mendel", + "tagKey": "5d776826961905001eb90e2b", + "thumb": "https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg" + } + ] + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 8b42e38..a9b5288 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/202.18/children \ +curl http://10.10.10.47:32400/library/metadata/4375.87/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -32,7 +32,37 @@ curl http://10.10.10.47:32400/library/metadata/202.18/children \ "viewGroup": "season", "viewMode": 65593, "Directory": [], - "Metadata": [] + "Metadata": [ + { + "ratingKey": "66488", + "key": "/library/metadata/66488/children", + "parentRatingKey": "30072", + "guid": "plex://season/652aea6549508477c34c6000", + "parentGuid": "plex://show/5d9c09190aaccd001f8f42f0", + "parentStudio": "Amazon Studios", + "type": "season", + "title": "Season 2", + "parentKey": "/library/metadata/30072", + "parentTitle": "Reacher", + "summary": "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "index": 2, + "parentIndex": 1, + "viewCount": 11, + "lastViewedAt": 1705646565, + "parentYear": 2022, + "thumb": "/library/metadata/66488/thumb/1703065033", + "art": "/library/metadata/30072/art/1705739923", + "parentThumb": "/library/metadata/30072/thumb/1705739923", + "parentTheme": "/library/metadata/30072/theme/1705739923", + "leafCount": 8, + "viewedLeafCount": 8, + "addedAt": 1702602021, + "updatedAt": 1703065033, + "userRating": 9, + "skipCount": 1, + "lastRatedAt": 1703881224 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx index e03bd90..13cfbd8 100644 --- a/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/3373.96/refresh \ +curl http://10.10.10.47:32400/library/sections/6235.64/refresh \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/library/search_library/_response.mdx b/content/pages/01-reference/curl/resources/library/search_library/_response.mdx index cf771e5..f3d34f4 100644 --- a/content/pages/01-reference/curl/resources/library/search_library/_response.mdx +++ b/content/pages/01-reference/curl/resources/library/search_library/_response.mdx @@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + diff --git a/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx index 57b1e1b..aa8f257 100644 --- a/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/87129/search \ +curl http://10.10.10.47:32400/library/sections/645894/search \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -22,7 +22,30 @@ curl http://10.10.10.47:32400/library/sections/87129/search \ "title2": "Search for ''", "viewGroup": "season", "viewMode": 65593, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "2", + "key": "/library/metadata/2/children", + "parentRatingKey": "1", + "guid": "plex://season/602e67e766dfdb002c0a1b5b", + "parentGuid": "plex://show/5d9c086c7d06d9001ffd27aa", + "parentStudio": "Mutant Enemy Productions", + "type": "season", + "title": "Season 1", + "parentKey": "/library/metadata/1", + "parentTitle": "Firefly", + "summary": "Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.", + "index": 1, + "parentIndex": 1, + "parentYear": 2002, + "thumb": "/library/metadata/2/thumb/1705636920", + "art": "/library/metadata/1/art/1705636920", + "parentThumb": "/library/metadata/1/thumb/1705636920", + "parentTheme": "/library/metadata/1/theme/1705636920", + "addedAt": 1705636916, + "updatedAt": 1705636920 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx index 0987042..5824b0a 100644 --- a/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx @@ -5,8 +5,12 @@ the media key --- ##### `time` _number_ The time, in milliseconds, used to set the media playback progress. +
+**Example:** `90000` --- ##### `state` _string_ The playback state of the media item. +
+**Example:** `played` diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx index f46d005..80cf941 100644 --- a/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=%3Cvalue%3E&time=7151.9 \ +curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=played&time=90000 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index 6c85d1d..c24ccf3 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ +curl http://10.10.10.47:32400/playlists/7917.25/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' ``` @@ -13,7 +13,23 @@ curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server "size": 1, "leafCountAdded": 1, "leafCountRequested": 1, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "94", + "key": "/playlists/94/items", + "guid": "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2", + "type": "playlist", + "title": "A great playlist", + "summary": "One of my great playlists", + "smart": false, + "playlistType": "video", + "composite": "/playlists/94/composite/1705800070", + "duration": 423000, + "leafCount": 3, + "addedAt": 1705716458, + "updatedAt": 1705800070 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index 9eb9cee..dfad9f8 100644 --- a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8700.88/items \ +curl http://10.10.10.47:32400/playlists/4776.65/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 4bcb39a..525090b 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&uri=%3Cvalue%3E \ +curl http://10.10.10.47:32400/playlists?playQueueID=2975.34&title=%3Cvalue%3E&uri=%3Cvalue%3E \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&ur { "MediaContainer": { "size": 7, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "96", + "key": "/playlists/96/items", + "guid": "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55", + "type": "playlist", + "title": "A Great Playlist", + "summary": "What a great playlist", + "smart": false, + "playlistType": "video", + "icon": "playlist://image.smart", + "viewCount": 1, + "lastViewedAt": 1705719589, + "leafCount": 1, + "addedAt": 1705719589, + "updatedAt": 1705724593, + "composite": "/playlists/96/composite/1705724593", + "duration": 141000 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 19f1a2e..5b6d6a6 100644 --- a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9571.56 \ +curl http://10.10.10.47:32400/playlists/567.13 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index 0a81710..38746a2 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8326.2 \ +curl http://10.10.10.47:32400/playlists/8917.73 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,7 +11,25 @@ curl http://10.10.10.47:32400/playlists/8326.2 \ { "MediaContainer": { "size": 1, - "Metadata": [] + "Metadata": [ + { + "content": "library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1", + "ratingKey": "95", + "key": "/playlists/95/items", + "guid": "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91", + "type": "playlist", + "title": "Smart Movie Playlist", + "summary": "", + "smart": true, + "playlistType": "video", + "composite": "/playlists/95/composite/1705717387", + "icon": "playlist://image.smart", + "duration": 282000, + "leafCount": 2, + "addedAt": 1705716493, + "updatedAt": 1705717387 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index 970c485..90d2bce 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \ +curl http://10.10.10.47:32400/playlists/2726.56/items?type=3834.41 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -18,7 +18,95 @@ curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \ "ratingKey": "95", "smart": true, "title": "Smart Movie Playlist", - "Metadata": [] + "Metadata": [ + { + "ratingKey": "17", + "key": "/library/metadata/17", + "guid": "plex://movie/5d77683f6f4521001ea9dc53", + "studio": "Universal Pictures", + "type": "movie", + "title": "Serenity", + "titleSort": "Amazing Spider-Man 2", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG-13", + "summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.", + "rating": 8.2, + "audienceRating": 9.1, + "year": 2005, + "tagline": "They aim to misbehave.", + "thumb": "/library/metadata/17/thumb/1705637165", + "art": "/library/metadata/17/art/1705637165", + "duration": 141416, + "originallyAvailableAt": "2005-09-29T00:00:00Z", + "addedAt": 1705637164, + "updatedAt": 1705637165, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "hasPremiumExtras": "1", + "hasPremiumPrimaryExtra": "1", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 15, + "duration": 141416, + "bitrate": 2273, + "width": 1920, + "height": 814, + "aspectRatio": 2.35, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 0, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 15, + "key": "/library/parts/15/1705637151/file.mp4", + "duration": 141416, + "file": "/movies/Serenity (2005)/Serenity (2005).mp4", + "size": 40271948, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": false, + "videoProfile": "high" + } + ] + } + ], + "Genre": [ + { + "tag": "Action" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "Joss Whedon" + } + ], + "Writer": [ + { + "tag": "Joss Whedon" + } + ], + "Role": [ + { + "tag": "Gina Torres" + } + ] + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx index 56a868b..05c201c 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx @@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists \ { "MediaContainer": { "size": 4, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "92", + "key": "/playlists/92/items", + "guid": "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903", + "type": "playlist", + "title": "Static Playlist", + "summary": "A Great Playlist", + "smart": false, + "playlistType": "video", + "composite": "/playlists/92/composite/1705716440", + "icon": "playlist://image.smart", + "viewCount": 1, + "lastViewedAt": 1705716298, + "duration": 7328000, + "leafCount": 32, + "addedAt": 1705716298, + "updatedAt": 1705716440 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index b180303..68639bc 100644 --- a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/7781.57?summary=%3Cvalue%3E&title=%3Cvalue%3E \ +curl http://10.10.10.47:32400/playlists/9636.63?summary=%3Cvalue%3E&title=%3Cvalue%3E \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx b/content/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx index 54819c7..22879a6 100644 --- a/content/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx @@ -1,14 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `X-Plex-Client-Identifier` _string_ -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- ##### `strong` _boolean (optional)_ Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non\-Strong codes are used for `Plex.tv/link` +--- +##### `X-Plex-Client-Identifier` _string (optional)_ +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + diff --git a/content/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx b/content/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx index 9e958e1..3a6e75f 100644 --- a/content/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx +++ b/content/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx @@ -3,8 +3,7 @@ ```bash Example Request curl https://plex.tv/api/v2/pins?strong=false \ --header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' \ ---header 'X-Plex-Client-Identifier: ' +--header 'X-Plex-Client-Identifier: Postman' ``` --- diff --git a/content/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx b/content/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx index 03a756b..c67eb4c 100644 --- a/content/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx @@ -3,9 +3,11 @@ The PinID to retrieve an access token for --- -##### `X-Plex-Client-Identifier` _string_ +##### `X-Plex-Client-Identifier` _string (optional)_ The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) +
+**Example:** `Postman` diff --git a/content/pages/01-reference/curl/resources/plex/get_token/_usage.mdx b/content/pages/01-reference/curl/resources/plex/get_token/_usage.mdx index 2709880..5b2885a 100644 --- a/content/pages/01-reference/curl/resources/plex/get_token/_usage.mdx +++ b/content/pages/01-reference/curl/resources/plex/get_token/_usage.mdx @@ -3,8 +3,7 @@ ```bash Example Request curl https://plex.tv/api/v2/pins/ \ --header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' \ ---header 'X-Plex-Client-Identifier: ' +--header 'X-Plex-Client-Identifier: Postman' ``` --- diff --git a/content/pages/01-reference/curl/resources/resources.mdx b/content/pages/01-reference/curl/resources/resources.mdx index dc73216..992c54d 100644 --- a/content/pages/01-reference/curl/resources/resources.mdx +++ b/content/pages/01-reference/curl/resources/resources.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/content/pages/01-reference/curl/resources/search/perform_search/_usage.mdx b/content/pages/01-reference/curl/resources/search/perform_search/_usage.mdx index 37aeb06..ea67300 100644 --- a/content/pages/01-reference/curl/resources/search/perform_search/_usage.mdx +++ b/content/pages/01-reference/curl/resources/search/perform_search/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=3927.85 \ +curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=5448.83 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx b/content/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx index 42fb2eb..fc26f1f 100644 --- a/content/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx +++ b/content/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=9255.97 \ +curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=8472.52 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx b/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx index 23931ef..e4614a3 100644 --- a/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx +++ b/content/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx @@ -11,7 +11,20 @@ curl http://10.10.10.47:32400/:/prefs \ { "MediaContainer": { "size": 161, - "Setting": [] + "Setting": [ + { + "id": "EnableDatabaseTrace", + "label": "", + "summary": "", + "type": "bool", + "default": false, + "value": false, + "hidden": true, + "advanced": false, + "group": "", + "enumValues": "1:admin only|2:everyone" + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx b/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx index ad383cc..94918fe 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx @@ -11,7 +11,29 @@ curl http://10.10.10.47:32400/status/sessions/history/all \ { "MediaContainer": { "size": 10855, - "Metadata": [] + "Metadata": [ + { + "historyKey": "/status/sessions/history/1", + "key": "/library/metadata/32171", + "ratingKey": "32171", + "librarySectionID": "2", + "parentKey": "/library/metadata/32170", + "grandparentKey": "/library/metadata/32132", + "title": "The Noise That Blue Makes", + "grandparentTitle": "Taskmaster", + "type": "episode", + "thumb": "/library/metadata/32171/thumb/-1", + "parentThumb": "/library/metadata/32170/thumb/1654134301", + "grandparentThumb": "/library/metadata/32132/thumb/1703933346", + "grandparentArt": "/library/metadata/32132/art/1703933346", + "index": 1, + "parentIndex": 13, + "originallyAvailableAt": "2022-04-14T00:00:00Z", + "viewedAt": 1654139223, + "accountID": 1, + "deviceID": 5 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx b/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx index 9488a0c..89a7f79 100644 --- a/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx +++ b/content/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx @@ -11,7 +11,118 @@ curl http://10.10.10.47:32400/status/sessions \ { "MediaContainer": { "size": 1, - "Metadata": [] + "Metadata": [ + { + "addedAt": 1705543312, + "art": "/library/metadata/39904/art/1705310687", + "duration": 186240, + "grandparentArt": "/library/metadata/39904/art/1705310687", + "grandparentGuid": "plex://artist/5d07bbfd403c6402904a6480", + "grandparentKey": "/library/metadata/39904", + "grandparentRatingKey": "39904", + "grandparentThumb": "/library/metadata/39904/thumb/1705310687", + "grandparentTitle": "Green Day", + "guid": "plex://track/6535834f71f22f36f71a8e8f", + "index": 1, + "key": "/library/metadata/67085", + "librarySectionID": "3", + "librarySectionKey": "/library/sections/3", + "librarySectionTitle": "Music", + "musicAnalysisVersion": "1", + "parentGuid": "plex://album/65394d6d472b8ab03ef47f12", + "parentIndex": 1, + "parentKey": "/library/metadata/67084", + "parentRatingKey": "67084", + "parentStudio": "Reprise Records", + "parentThumb": "/library/metadata/67084/thumb/1705543314", + "parentTitle": "Saviors", + "parentYear": 2024, + "ratingCount": 45885, + "ratingKey": "67085", + "sessionKey": "203", + "thumb": "/library/metadata/67084/thumb/1705543314", + "title": "The American Dream Is Killing Me", + "titleSort": "American Dream Is Killing Me", + "type": "track", + "updatedAt": 1705543314, + "viewOffset": 1000, + "Media": [ + { + "audioChannels": 2, + "audioCodec": "flac", + "bitrate": 1014, + "container": "flac", + "duration": 186240, + "id": "130355", + "selected": true, + "Part": [ + { + "container": "flac", + "duration": 186240, + "file": "/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac", + "hasThumbnail": "1", + "id": "130625", + "key": "/library/parts/130625/1705543268/file.flac", + "size": 23644000, + "decision": "directplay", + "selected": true, + "Stream": [ + { + "albumGain": "-12.94", + "albumPeak": "1.000000", + "albumRange": "4.751014", + "audioChannelLayout": "stereo", + "bitDepth": 16, + "bitrate": 1014, + "channels": 2, + "codec": "flac", + "displayTitle": "FLAC (Stereo)", + "extendedDisplayTitle": "FLAC (Stereo)", + "gain": "-12.94", + "id": "352487", + "index": 0, + "loudness": "-5.94", + "lra": "1.74", + "peak": "1.000000", + "samplingRate": 44100, + "selected": true, + "streamType": 2, + "location": "direct" + } + ] + } + ] + } + ], + "User": { + "id": "1", + "thumb": "https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661", + "title": "Blindkitty38" + }, + "Player": { + "address": "10.10.10.171", + "machineIdentifier": "3tsdzir85m2onc3qyr255aq1", + "model": "standalone", + "platform": "windows", + "platformVersion": "10.0.22621", + "product": "Plex for Windows", + "profile": "Plex Desktop", + "remotePublicAddress": "68.248.140.20", + "state": "playing", + "title": "DESKTOP-BL80MTD", + "version": "1.85.0.4071-21128b56", + "local": true, + "relayed": false, + "secure": true, + "userID": 1 + }, + "Session": { + "id": "93h7e00ncblxncqw9lkfaoxi", + "bandwidth": 1050, + "location": "lan" + } + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx b/content/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx index 855e013..6db0d79 100644 --- a/content/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx @@ -3,4 +3,6 @@ The timespan to retrieve statistics for the exact meaning of this parameter is not known +
+**Example:** `4` diff --git a/content/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx b/content/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx index 73d1f06..70025d1 100644 --- a/content/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx +++ b/content/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \ +curl http://10.10.10.47:32400/statistics/media?Timespan=4 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,9 +11,38 @@ curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \ { "MediaContainer": { "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] + "Device": [ + { + "id": 208, + "name": "Roku Express", + "platform": "Roku", + "clientIdentifier": "793095d235660625108ef785cc7646e9", + "createdAt": 1706470556 + } + ], + "Account": [ + { + "id": 238960586, + "key": "/accounts/238960586", + "name": "Diane", + "defaultAudioLanguage": "en", + "autoSelectAudio": true, + "defaultSubtitleLanguage": "en", + "subtitleMode": 1, + "thumb": "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967" + } + ], + "StatisticsMedia": [ + { + "accountID": 1, + "deviceID": 13, + "timespan": 4, + "at": 1707141600, + "metadataType": 4, + "count": 1, + "duration": 1555 + } + ] } } ``` diff --git a/content/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx b/content/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx index 736472f..82d4909 100644 --- a/content/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx @@ -6,6 +6,8 @@ import Labels from "/src/lib/labels"; ##### `tonight` _enumeration (optional)_ Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install +
+**Example:** `1` @@ -14,6 +16,8 @@ Indicate that you want the update to run during the next Butler execution. Omitt --- ##### `skip` _enumeration (optional)_ Indicate that the latest version should be marked as skipped. The \ entry for this version will have the `state` set to `skipped`. +
+**Example:** `1` diff --git a/content/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx b/content/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx index 2470ae2..3ad5918 100644 --- a/content/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx @@ -5,6 +5,8 @@ import Labels from "/src/lib/labels"; ##### `download` _enumeration (optional)_ Indicate that you want to start download any updates found. +
+**Example:** `1` diff --git a/content/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx b/content/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx index 3a91bd8..2cee9b6 100644 --- a/content/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx @@ -5,14 +5,20 @@ import Labels from "/src/lib/labels"; ##### `ratingKey` _number_ The rating key of the media item +
+**Example:** `23409` --- ##### `key` _string_ The key of the media item to get the timeline for +
+**Example:** `/library/metadata/23409` --- ##### `state` _enumeration_ The state of the media item +
+**Example:** `playing` @@ -21,28 +27,42 @@ The state of the media item --- ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `time` _number_ The time of the media item +
+**Example:** `2000` --- ##### `duration` _number_ The duration of the media item +
+**Example:** `10000` --- ##### `context` _string_ The context of the media item +
+**Example:** `home:hub.continueWatching` --- ##### `playQueueItemID` _number_ The play queue item ID of the media item +
+**Example:** `1` --- ##### `playBackTime` _number_ The playback time of the media item +
+**Example:** `2000` --- ##### `row` _number_ The row of the media item +
+**Example:** `1` diff --git a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index 8662e16..ed331b1 100644 --- a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=%3Cvalue%3E&duration=5448.83&hasMDE=6027.63&key=%3Cvalue%3E&playBackTime=4236.55&playQueueItemID=8472.52&ratingKey=8442.66&row=6235.64&time=8579.46 \ +curl http://10.10.10.47:32400/:/timeline?context=home%3Ahub.continueWatching&duration=10000&hasMDE=1&key=%2Flibrary%2Fmetadata%2F23409&playBackTime=2000&playQueueItemID=1&ratingKey=23409&row=1&time=2000 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx index bc4914e..9b5a10a 100644 --- a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx @@ -1,64 +1,96 @@ {/* Autogenerated DO NOT EDIT */} ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `path` _string_ The path to the media item to transcode +
+**Example:** `/library/metadata/23409` --- ##### `mediaIndex` _number_ The index of the media item to transcode +
+**Example:** `0` --- ##### `partIndex` _number_ The index of the part to transcode +
+**Example:** `0` --- ##### `protocol` _string_ The protocol to use for the transcode session +
+**Example:** `hls` --- ##### `fastSeek` _number (optional)_ Whether to use fast seek or not +
+**Example:** `0` --- ##### `directPlay` _number (optional)_ Whether to use direct play or not +
+**Example:** `0` --- ##### `directStream` _number (optional)_ Whether to use direct stream or not +
+**Example:** `0` --- ##### `subtitleSize` _number (optional)_ The size of the subtitles +
+**Example:** `100` --- ##### `subtites` _string (optional)_ The subtitles +
+**Example:** `burn` --- ##### `audioBoost` _number (optional)_ The audio boost +
+**Example:** `100` --- ##### `location` _string (optional)_ The location of the transcode session +
+**Example:** `lan` --- ##### `mediaBufferSize` _number (optional)_ The size of the media buffer +
+**Example:** `102400` --- ##### `session` _string (optional)_ The session ID +
+**Example:** `zvcage8b7rkioqcm8f4uns4c` --- ##### `addDebugOverlay` _number (optional)_ Whether to add a debug overlay or not +
+**Example:** `0` --- ##### `autoAdjustQuality` _number (optional)_ Whether to auto adjust quality or not +
+**Example:** `0` diff --git a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index 3fd4b2e..4e744a9 100644 --- a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4776.65&audioBoost=2726.56&autoAdjustQuality=7917.25&directPlay=8917.73&directStream=567.13&fastSeek=2975.34&hasMDE=6458.94&location=%3Cvalue%3E&mediaBufferSize=3834.41&mediaIndex=3843.82&partIndex=4375.87&path=%3Cvalue%3E&protocol=%3Cvalue%3E&session=%3Cvalue%3E&subtites=%3Cvalue%3E&subtitleSize=9636.63 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=0&audioBoost=100&autoAdjustQuality=0&directPlay=0&directStream=0&fastSeek=0&hasMDE=1&location=lan&mediaBufferSize=102400&mediaIndex=0&partIndex=0&path=%2Flibrary%2Fmetadata%2F23409&protocol=hls&session=zvcage8b7rkioqcm8f4uns4c&subtites=burn&subtitleSize=100 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/go/errors/_snippet.mdx b/content/pages/01-reference/go/errors/_snippet.mdx index 52edff7..6f958d4 100644 --- a/content/pages/01-reference/go/errors/_snippet.mdx +++ b/content/pages/01-reference/go/errors/_snippet.mdx @@ -12,7 +12,6 @@ import ( "context" "errors" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "github.com/LukeHagar/plexgo/models/sdkerrors" "log" ) @@ -20,6 +19,7 @@ import ( func main() { s := plexgo.New( plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() diff --git a/content/pages/01-reference/go/global_parameters/_snippet.mdx b/content/pages/01-reference/go/global_parameters/_snippet.mdx new file mode 100644 index 0000000..1ce2583 --- /dev/null +++ b/content/pages/01-reference/go/global_parameters/_snippet.mdx @@ -0,0 +1,36 @@ +{/* Start Go Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```go +package main + +import ( + "context" + "github.com/LukeHagar/plexgo" + "log" +) + +func main() { + s := plexgo.New( + plexgo.WithXPlexClientIdentifier("Postman"), + ) + var strong *bool = plexgo.Bool(false) + + var xPlexClientIdentifier *string = plexgo.String("Postman") + ctx := context.Background() + res, err := s.Plex.GetPin(ctx, strong, xPlexClientIdentifier) + if err != nil { + log.Fatal(err) + } + if res.Object != nil { + // handle response + } +} + +``` +{/* End Go Global Parameters */} diff --git a/content/pages/01-reference/go/global_parameters/global_parameters.mdx b/content/pages/01-reference/go/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..9ad2aa0 --- /dev/null +++ b/content/pages/01-reference/go/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* render global_parameters */} \ No newline at end of file diff --git a/content/pages/01-reference/go/go.mdx b/content/pages/01-reference/go/go.mdx index b133698..a55934b 100644 --- a/content/pages/01-reference/go/go.mdx +++ b/content/pages/01-reference/go/go.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/src/.gen/pages/01-reference/curl/resources/security/security_content.mdx b/content/pages/01-reference/go/resources/authentication/authentication.mdx similarity index 50% rename from src/.gen/pages/01-reference/curl/resources/security/security_content.mdx rename to content/pages/01-reference/go/resources/authentication/authentication.mdx index 8f7bfb3..ee8a683 100644 --- a/src/.gen/pages/01-reference/curl/resources/security/security_content.mdx +++ b/content/pages/01-reference/go/resources/authentication/authentication.mdx @@ -1,14 +1,14 @@ import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; -## Security -API Calls against Security for Plex Media Server +## Authentication +API Calls regarding authentication for Plex Media Server ### Available Operations -* [Get Transient Token](/curl/security/get_transient_token) - Get a Transient Token. -* [Get Source Connection Information](/curl/security/get_source_connection_information) - Get Source Connection Information +* [Get Transient Token](/go/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/go/authentication/get_source_connection_information) - Get Source Connection Information --- diff --git a/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/content/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx similarity index 55% rename from content/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx rename to content/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx index b880469..8b0f80b 100644 --- a/content/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx +++ b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx @@ -3,8 +3,8 @@ The context to use for the request. --- -##### `timespan` *{`*int64`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - +##### `source` *{`string`}* +The source identifier with an included prefix. +
+**Example:** `server://client-identifier` diff --git a/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..a4d2b63 --- /dev/null +++ b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`*operations.GetSourceConnectionInformationResponse`}* + + + + + + +--- +##### *{`error`}* + + diff --git a/content/pages/01-reference/go/resources/plex/get_token/_usage.mdx b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx similarity index 50% rename from content/pages/01-reference/go/resources/plex/get_token/_usage.mdx rename to content/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx index 3707391..b892456 100644 --- a/content/pages/01-reference/go/resources/plex/get_token/_usage.mdx +++ b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx @@ -1,33 +1,26 @@ -```go GetToken.go +```go GetSourceConnectionInformation.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(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) - - - var pinID string = "" - - var xPlexClientIdentifier string = "" - + var source string = "provider://provider-identifier" ctx := context.Background() - res, err := s.Plex.GetToken(ctx, pinID, xPlexClientIdentifier) + res, err := s.Authentication.GetSourceConnectionInformation(ctx, source) if err != nil { log.Fatal(err) } - - if res.StatusCode == http.StatusOK { + if res != nil { // handle response } } @@ -38,11 +31,12 @@ func main() { { "errors": [ { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 + "code": 1001, + "message": "User could not be authenticated", + "status": 401 } - ] + ], + "HttpMeta": {} } ``` diff --git a/content/pages/01-reference/go/resources/plex/get_pin/get_pin.mdx b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 91% rename from content/pages/01-reference/go/resources/plex/get_pin/get_pin.mdx rename to content/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx index c73f5dc..c4b35e7 100644 --- a/content/pages/01-reference/go/resources/plex/get_pin/get_pin.mdx +++ b/content/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Plex* +###### *Authentication* } diff --git a/content/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx b/content/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/content/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/content/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx b/content/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..75f5abe --- /dev/null +++ b/content/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,25 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/go.mdx" +import Scope from "/content/types/models/operations/scope/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. + +--- +##### `type_` *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope` *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + diff --git a/content/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx b/content/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx similarity index 58% rename from content/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx rename to content/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx index e73915f..ed38c60 100644 --- a/content/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx +++ b/content/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx @@ -1,12 +1,12 @@ {/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/go.mdx" +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/go.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### *{`*operations.GetStatisticsResponse`}* +##### *{`*operations.GetTransientTokenResponse`}* - + diff --git a/content/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx b/content/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..1227883 --- /dev/null +++ b/content/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,45 @@ + + +```go GetTransientToken.go +package main + +import( + "github.com/LukeHagar/plexgo" + "github.com/LukeHagar/plexgo/models/operations" + "context" + "log" +) + +func main() { + s := plexgo.New( + plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), + ) + var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation + + var scope operations.Scope = operations.ScopeAll + ctx := context.Background() + res, err := s.Authentication.GetTransientToken(ctx, type_, scope) + if err != nil { + log.Fatal(err) + } + if res != nil { + // handle response + } +} +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/content/pages/01-reference/go/resources/plex/get_token/get_token.mdx b/content/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 91% rename from content/pages/01-reference/go/resources/plex/get_token/get_token.mdx rename to content/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx index c73f5dc..c4b35e7 100644 --- a/content/pages/01-reference/go/resources/plex/get_token/get_token.mdx +++ b/content/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Plex* +###### *Authentication* } diff --git a/content/pages/01-reference/go/resources/plex/get_pin/_header.mdx b/content/pages/01-reference/go/resources/plex/get_pin/_header.mdx deleted file mode 100644 index 5c6a65f..0000000 --- a/content/pages/01-reference/go/resources/plex/get_pin/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file diff --git a/content/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx b/content/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx deleted file mode 100644 index 6fd9d82..0000000 --- a/content/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx +++ /dev/null @@ -1,22 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `xPlexClientIdentifier` *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong` *{`*bool`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `opts` *{`[]operations.Option`}* -The options for this request. - diff --git a/content/pages/01-reference/go/resources/plex/get_pin/_usage.mdx b/content/pages/01-reference/go/resources/plex/get_pin/_usage.mdx deleted file mode 100644 index 23aa07c..0000000 --- a/content/pages/01-reference/go/resources/plex/get_pin/_usage.mdx +++ /dev/null @@ -1,63 +0,0 @@ - - -```go GetPin.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var xPlexClientIdentifier string = "" - - var strong *bool = plexgo.Bool(false) - - ctx := context.Background() - res, err := s.Plex.GetPin(ctx, xPlexClientIdentifier, strong) - if err != nil { - log.Fatal(err) - } - - if res.Object != nil { - // handle response - } -} -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - diff --git a/content/pages/01-reference/go/resources/plex/get_token/_header.mdx b/content/pages/01-reference/go/resources/plex/get_token/_header.mdx deleted file mode 100644 index 17a7e70..0000000 --- a/content/pages/01-reference/go/resources/plex/get_token/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file diff --git a/content/pages/01-reference/go/resources/plex/get_token/_parameters.mdx b/content/pages/01-reference/go/resources/plex/get_token/_parameters.mdx deleted file mode 100644 index d1c43ed..0000000 --- a/content/pages/01-reference/go/resources/plex/get_token/_parameters.mdx +++ /dev/null @@ -1,19 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `pinID` *{`string`}* -The PinID to retrieve an access token for - ---- -##### `xPlexClientIdentifier` *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `opts` *{`[]operations.Option`}* -The options for this request. - diff --git a/content/pages/01-reference/go/resources/resources.mdx b/content/pages/01-reference/go/resources/resources.mdx index dc73216..992c54d 100644 --- a/content/pages/01-reference/go/resources/resources.mdx +++ b/content/pages/01-reference/go/resources/resources.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/content/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx b/content/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx deleted file mode 100644 index c9ff431..0000000 --- a/content/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file diff --git a/content/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx b/content/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx deleted file mode 100644 index 75e2458..0000000 --- a/content/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx +++ /dev/null @@ -1,44 +0,0 @@ - - -```go GetStatistics.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var timespan *int64 = plexgo.Int64(944669) - - ctx := context.Background() - res, err := s.Statistics.GetStatistics(ctx, timespan) - if err != nil { - log.Fatal(err) - } - - if res.Object != nil { - // handle response - } -} -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - diff --git a/content/pages/01-reference/go/resources/statistics/get_statistics/get_statistics.mdx b/content/pages/01-reference/go/resources/statistics/get_statistics/get_statistics.mdx deleted file mode 100644 index 84ec074..0000000 --- a/content/pages/01-reference/go/resources/statistics/get_statistics/get_statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/go/resources/statistics/statistics.mdx b/content/pages/01-reference/go/resources/statistics/statistics.mdx deleted file mode 100644 index 7da9a99..0000000 --- a/content/pages/01-reference/go/resources/statistics/statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/go/statistics/get_statistics) - Get Media Statistics - ---- - diff --git a/content/pages/01-reference/go/security_options/_snippet.mdx b/content/pages/01-reference/go/security_options/_snippet.mdx index ffbdb5c..f33427e 100644 --- a/content/pages/01-reference/go/security_options/_snippet.mdx +++ b/content/pages/01-reference/go/security_options/_snippet.mdx @@ -18,6 +18,7 @@ import ( func main() { s := plexgo.New( plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -25,7 +26,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } diff --git a/content/pages/01-reference/go/server_options/_snippet.mdx b/content/pages/01-reference/go/server_options/_snippet.mdx index da8f920..a767908 100644 --- a/content/pages/01-reference/go/server_options/_snippet.mdx +++ b/content/pages/01-reference/go/server_options/_snippet.mdx @@ -14,7 +14,6 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "log" ) @@ -22,6 +21,7 @@ func main() { s := plexgo.New( plexgo.WithServerIndex(0), plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -29,7 +29,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } @@ -53,7 +52,6 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "log" ) @@ -61,6 +59,7 @@ func main() { s := plexgo.New( plexgo.WithServerURL("{protocol}://{ip}:{port}"), plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -68,7 +67,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } @@ -85,25 +83,22 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" + "github.com/LukeHagar/plexgo/models/operations" "log" ) func main() { s := plexgo.New( - plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) - - var xPlexClientIdentifier string = "" - var strong *bool = plexgo.Bool(false) + var xPlexClientIdentifier *string = plexgo.String("Postman") ctx := context.Background() - res, err := s.Plex.GetPin(ctx, operations.WithServerURL("https://plex.tv/api/v2"), xPlexClientIdentifier, strong) + res, err := s.Plex.GetPin(ctx, strong, xPlexClientIdentifier, operations.WithServerURL("https://plex.tv/api/v2")) if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } diff --git a/content/pages/01-reference/python/custom_http_client/_snippet.mdx b/content/pages/01-reference/python/custom_http_client/_snippet.mdx index 7e3a156..bc53609 100644 --- a/content/pages/01-reference/python/custom_http_client/_snippet.mdx +++ b/content/pages/01-reference/python/custom_http_client/_snippet.mdx @@ -8,6 +8,6 @@ import requests http_client = requests.Session() http_client.headers.update({'x-custom-header': 'someValue'}) -s = plex_api.PlexAPI(client: http_client) +s = plex_api.PlexAPI(client=http_client) ``` {/* End Python Custom HTTP Client */} diff --git a/content/pages/01-reference/python/errors/_snippet.mdx b/content/pages/01-reference/python/errors/_snippet.mdx index 9f01e79..0ddf205 100644 --- a/content/pages/01-reference/python/errors/_snippet.mdx +++ b/content/pages/01-reference/python/errors/_snippet.mdx @@ -11,12 +11,13 @@ from plex_api.models import errors s = plex_api.PlexAPI( access_token="", + x_plex_client_identifier='Postman', ) - res = None try: res = s.server.get_server_capabilities() + except errors.GetServerCapabilitiesResponseBody as e: # handle exception raise(e) @@ -27,6 +28,7 @@ except errors.SDKError as e: if res.object is not None: # handle response pass + ``` {/* End Python Errors */} diff --git a/content/pages/01-reference/python/global_parameters/_snippet.mdx b/content/pages/01-reference/python/global_parameters/_snippet.mdx new file mode 100644 index 0000000..a9f99b5 --- /dev/null +++ b/content/pages/01-reference/python/global_parameters/_snippet.mdx @@ -0,0 +1,24 @@ +{/* Start Python Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `'Postman'` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```python +import plex_api + +s = plex_api.PlexAPI( + x_plex_client_identifier='Postman', +) + + +res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman') + +if res.object is not None: + # handle response + pass + +``` +{/* End Python Global Parameters */} diff --git a/content/pages/01-reference/python/global_parameters/global_parameters.mdx b/content/pages/01-reference/python/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..9ad2aa0 --- /dev/null +++ b/content/pages/01-reference/python/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* render global_parameters */} \ No newline at end of file diff --git a/content/pages/01-reference/python/python.mdx b/content/pages/01-reference/python/python.mdx index b133698..a55934b 100644 --- a/content/pages/01-reference/python/python.mdx +++ b/content/pages/01-reference/python/python.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/content/pages/01-reference/python/resources/authentication/authentication.mdx b/content/pages/01-reference/python/resources/authentication/authentication.mdx new file mode 100644 index 0000000..fd6a3bf --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/authentication.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/python/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/python/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx new file mode 100644 index 0000000..3b26ff4 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `source` *{`str`}* +The source identifier with an included prefix. +
+**Example:** `server://client-identifier` + diff --git a/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..b33c252 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`operations.GetSourceConnectionInformationResponse`}* + + + + + + + diff --git a/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx new file mode 100644 index 0000000..432f56e --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx @@ -0,0 +1,33 @@ + + +```python GetSourceConnectionInformation.py +import plex_api + +s = plex_api.PlexAPI( + access_token="", + x_plex_client_identifier='Postman', +) + + +res = s.authentication.get_source_connection_information(source='provider://provider-identifier') + +if res is not None: + # handle response + pass + +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/content/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx new file mode 100644 index 0000000..c4b35e7 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx b/content/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/content/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx b/content/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..05f54a2 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/python.mdx" +import Scope from "/content/types/models/operations/scope/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type` *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope` *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + diff --git a/content/pages/01-reference/python/resources/plex/get_pin/_response.mdx b/content/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx similarity index 55% rename from content/pages/01-reference/python/resources/plex/get_pin/_response.mdx rename to content/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx index aa52594..2668a89 100644 --- a/content/pages/01-reference/python/resources/plex/get_pin/_response.mdx +++ b/content/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx @@ -1,12 +1,12 @@ {/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/python.mdx" +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/python.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### *{`operations.GetPinResponse`}* +##### *{`operations.GetTransientTokenResponse`}* - + diff --git a/content/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx b/content/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..0f1e577 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,34 @@ + + +```python GetTransientToken.py +import plex_api +from plex_api.models import operations + +s = plex_api.PlexAPI( + access_token="", + x_plex_client_identifier='Postman', +) + + +res = s.authentication.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) + +if res is not None: + # handle response + pass + +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/content/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx b/content/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx new file mode 100644 index 0000000..c4b35e7 --- /dev/null +++ b/content/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/python/resources/plex/get_pin/_header.mdx b/content/pages/01-reference/python/resources/plex/get_pin/_header.mdx deleted file mode 100644 index 5c6a65f..0000000 --- a/content/pages/01-reference/python/resources/plex/get_pin/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file diff --git a/content/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx b/content/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx deleted file mode 100644 index 7c3c933..0000000 --- a/content/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx +++ /dev/null @@ -1,18 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `x_plex_client_identifier` *{`str`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong` *{`Optional[bool]`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `server_url` *{`Optional[str]`}* -An optional server URL to use. - diff --git a/content/pages/01-reference/python/resources/plex/get_pin/_usage.mdx b/content/pages/01-reference/python/resources/plex/get_pin/_usage.mdx deleted file mode 100644 index e9b4f03..0000000 --- a/content/pages/01-reference/python/resources/plex/get_pin/_usage.mdx +++ /dev/null @@ -1,46 +0,0 @@ - - -```python GetPin.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.plex.get_pin(x_plex_client_identifier='', strong=False) - -if res.object is not None: - # handle response - pass -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - diff --git a/content/pages/01-reference/python/resources/plex/get_pin/get_pin.mdx b/content/pages/01-reference/python/resources/plex/get_pin/get_pin.mdx deleted file mode 100644 index c73f5dc..0000000 --- a/content/pages/01-reference/python/resources/plex/get_pin/get_pin.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/python/resources/plex/get_token/_header.mdx b/content/pages/01-reference/python/resources/plex/get_token/_header.mdx deleted file mode 100644 index 17a7e70..0000000 --- a/content/pages/01-reference/python/resources/plex/get_token/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file diff --git a/content/pages/01-reference/python/resources/plex/get_token/_usage.mdx b/content/pages/01-reference/python/resources/plex/get_token/_usage.mdx deleted file mode 100644 index 5365593..0000000 --- a/content/pages/01-reference/python/resources/plex/get_token/_usage.mdx +++ /dev/null @@ -1,30 +0,0 @@ - - -```python GetToken.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.plex.get_token(pin_id='', x_plex_client_identifier='') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 - } - ] - } -``` - diff --git a/content/pages/01-reference/python/resources/plex/get_token/get_token.mdx b/content/pages/01-reference/python/resources/plex/get_token/get_token.mdx deleted file mode 100644 index c73f5dc..0000000 --- a/content/pages/01-reference/python/resources/plex/get_token/get_token.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/python/resources/resources.mdx b/content/pages/01-reference/python/resources/resources.mdx index dc73216..992c54d 100644 --- a/content/pages/01-reference/python/resources/resources.mdx +++ b/content/pages/01-reference/python/resources/resources.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/content/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx b/content/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx deleted file mode 100644 index c9ff431..0000000 --- a/content/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file diff --git a/content/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx b/content/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx deleted file mode 100644 index abeb7eb..0000000 --- a/content/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx +++ /dev/null @@ -1,6 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `timespan` *{`Optional[int]`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - diff --git a/content/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx b/content/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx deleted file mode 100644 index ba7403e..0000000 --- a/content/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetStatisticsResponse`}* - - - - - - - diff --git a/content/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx b/content/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx deleted file mode 100644 index 50246c5..0000000 --- a/content/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx +++ /dev/null @@ -1,29 +0,0 @@ - - -```python GetStatistics.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.statistics.get_statistics(timespan=944669) - -if res.object is not None: - # handle response - pass -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - diff --git a/content/pages/01-reference/python/resources/statistics/get_statistics/get_statistics.mdx b/content/pages/01-reference/python/resources/statistics/get_statistics/get_statistics.mdx deleted file mode 100644 index 84ec074..0000000 --- a/content/pages/01-reference/python/resources/statistics/get_statistics/get_statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/python/resources/statistics/statistics.mdx b/content/pages/01-reference/python/resources/statistics/statistics.mdx deleted file mode 100644 index 665a72a..0000000 --- a/content/pages/01-reference/python/resources/statistics/statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/python/statistics/get_statistics) - Get Media Statistics - ---- - diff --git a/content/pages/01-reference/python/security_options/_snippet.mdx b/content/pages/01-reference/python/security_options/_snippet.mdx index a252a06..757f25e 100644 --- a/content/pages/01-reference/python/security_options/_snippet.mdx +++ b/content/pages/01-reference/python/security_options/_snippet.mdx @@ -11,6 +11,7 @@ import plex_api s = plex_api.PlexAPI( access_token="", + x_plex_client_identifier='Postman', ) @@ -19,5 +20,6 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` {/* End Python Security Options */} diff --git a/content/pages/01-reference/python/server_options/_snippet.mdx b/content/pages/01-reference/python/server_options/_snippet.mdx index a632230..75d248a 100644 --- a/content/pages/01-reference/python/server_options/_snippet.mdx +++ b/content/pages/01-reference/python/server_options/_snippet.mdx @@ -14,6 +14,7 @@ import plex_api s = plex_api.PlexAPI( server_idx=0, access_token="", + x_plex_client_identifier='Postman', ) @@ -22,6 +23,7 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` #### Variables @@ -40,6 +42,7 @@ import plex_api s = plex_api.PlexAPI( server_url="{protocol}://{ip}:{port}", access_token="", + x_plex_client_identifier='Postman', ) @@ -48,6 +51,7 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` ### Override Server URL Per-Operation @@ -57,14 +61,15 @@ The server URL can also be overridden on a per-operation basis, provided a serve import plex_api s = plex_api.PlexAPI( - access_token="", + x_plex_client_identifier='Postman', ) -res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='', strong=False) +res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman', server_url="https://plex.tv/api/v2") if res.object is not None: # handle response pass + ``` {/* End Python Server Options */} diff --git a/content/pages/01-reference/typescript/custom_http_client/_snippet.mdx b/content/pages/01-reference/typescript/custom_http_client/_snippet.mdx index d0bfc8c..e57d258 100644 --- a/content/pages/01-reference/typescript/custom_http_client/_snippet.mdx +++ b/content/pages/01-reference/typescript/custom_http_client/_snippet.mdx @@ -26,7 +26,7 @@ const httpClient = new HTTPClient({ httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { - signal: request.signal || AbortSignal.timeout(5000); + signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); diff --git a/content/pages/01-reference/typescript/errors/_snippet.mdx b/content/pages/01-reference/typescript/errors/_snippet.mdx index 1c820c0..18898f6 100644 --- a/content/pages/01-reference/typescript/errors/_snippet.mdx +++ b/content/pages/01-reference/typescript/errors/_snippet.mdx @@ -3,21 +3,31 @@ All SDK methods return a response object or throw an error. If Error objects are -Example +Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. + ```typescript import { PlexAPI } from "@lukehagar/plexjs"; +import * as errors from "@lukehagar/plexjs/models/errors"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - let result; try { - result = await sdk.server.getServerCapabilities(); + result = await plexAPI.server.getServerCapabilities(); } catch (err) { switch (true) { + case err instanceof errors.SDKValidationError: { + // Validation errors can be pretty-printed + console.error(err.pretty()); + // Raw value may also be inspected + console.error(err.rawValue); + return; + } case err instanceof errors.GetServerCapabilitiesResponseBody: { console.error(err); // handle exception return; diff --git a/content/pages/01-reference/typescript/global_parameters/_snippet.mdx b/content/pages/01-reference/typescript/global_parameters/_snippet.mdx new file mode 100644 index 0000000..9388606 --- /dev/null +++ b/content/pages/01-reference/typescript/global_parameters/_snippet.mdx @@ -0,0 +1,26 @@ +{/* Start Typescript Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```typescript +import { PlexAPI } from "@lukehagar/plexjs"; + +const plexAPI = new PlexAPI({ + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.plex.getPin(false, "Postman"); + + // Handle the result + console.log(result); +} + +run(); + +``` +{/* End Typescript Global Parameters */} diff --git a/content/pages/01-reference/typescript/global_parameters/global_parameters.mdx b/content/pages/01-reference/typescript/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..9ad2aa0 --- /dev/null +++ b/content/pages/01-reference/typescript/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* render global_parameters */} \ No newline at end of file diff --git a/content/pages/01-reference/typescript/resources/authentication/authentication.mdx b/content/pages/01-reference/typescript/resources/authentication/authentication.mdx new file mode 100644 index 0000000..f55542e --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/authentication.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/typescript/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/typescript/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx similarity index 77% rename from content/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx rename to content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx index 5e7431e..f3ecef9 100644 --- a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx @@ -1,8 +1,8 @@ {/* Autogenerated DO NOT EDIT */} -##### `timespan?`: *{`number`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - +##### `source`: *{`string`}* +The source identifier with an included prefix. +
+**Example:** `[object Object]` --- ##### `options?`: *{`RequestOptions`}* diff --git a/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..38e81ec --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`Promise\`}* + + + + + + + diff --git a/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx new file mode 100644 index 0000000..332f1a1 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx @@ -0,0 +1,34 @@ + + +```typescript GetSourceConnectionInformation.ts +import { PlexAPI } from "@lukehagar/plexjs"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.authentication.getSourceConnectionInformation("provider://provider-identifier"); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx new file mode 100644 index 0000000..c4b35e7 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..f8aa661 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,29 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx" +import Scope from "/content/types/models/operations/scope/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type`: *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope`: *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + +--- +##### `options?`: *{`RequestOptions`}* +Options for making HTTP requests. + +--- +##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) +Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. + diff --git a/content/pages/01-reference/go/resources/plex/get_token/_response.mdx b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx similarity index 53% rename from content/pages/01-reference/go/resources/plex/get_token/_response.mdx rename to content/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx index f91fd35..1293adc 100644 --- a/content/pages/01-reference/go/resources/plex/get_token/_response.mdx +++ b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx @@ -1,16 +1,13 @@ {/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/go.mdx" +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/typescript.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### *{`*operations.GetTokenResponse`}* +##### *{`Promise\`}* - + ---- -##### *{`error`}* - diff --git a/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..36da46c --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,35 @@ + + +```typescript GetTransientToken.ts +import { PlexAPI } from "@lukehagar/plexjs"; +import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.authentication.getTransientToken(GetTransientTokenQueryParamType.Delegation, Scope.All); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/content/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx new file mode 100644 index 0000000..c4b35e7 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx b/content/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx deleted file mode 100644 index 5c6a65f..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file diff --git a/content/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx b/content/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx deleted file mode 100644 index b45d4b5..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `xPlexClientIdentifier`: *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong?`: *{`boolean`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - ---- -##### `options.serverURL?`: *{`string`}* -An optional server URL to use. - diff --git a/content/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx b/content/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx deleted file mode 100644 index 6d93dd4..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/content/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx b/content/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx deleted file mode 100644 index 2cbbc54..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx +++ /dev/null @@ -1,51 +0,0 @@ - - -```typescript GetPin.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const xPlexClientIdentifier = ""; - const strong = false; - - const result = await sdk.plex.getPin(xPlexClientIdentifier, strong); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - diff --git a/content/pages/01-reference/typescript/resources/plex/get_pin/get_pin.mdx b/content/pages/01-reference/typescript/resources/plex/get_pin/get_pin.mdx deleted file mode 100644 index c73f5dc..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_pin/get_pin.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/plex/get_token/_header.mdx b/content/pages/01-reference/typescript/resources/plex/get_token/_header.mdx deleted file mode 100644 index 17a7e70..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_token/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file diff --git a/content/pages/01-reference/typescript/resources/plex/get_token/_response.mdx b/content/pages/01-reference/typescript/resources/plex/get_token/_response.mdx deleted file mode 100644 index e733907..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_token/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/content/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx b/content/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx deleted file mode 100644 index 1912999..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx +++ /dev/null @@ -1,36 +0,0 @@ - - -```typescript GetToken.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const pinID = ""; - const xPlexClientIdentifier = ""; - - const result = await sdk.plex.getToken(pinID, xPlexClientIdentifier); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 - } - ], - "HttpMeta": {} - } -``` - diff --git a/content/pages/01-reference/typescript/resources/plex/get_token/get_token.mdx b/content/pages/01-reference/typescript/resources/plex/get_token/get_token.mdx deleted file mode 100644 index c73f5dc..0000000 --- a/content/pages/01-reference/typescript/resources/plex/get_token/get_token.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/resources.mdx b/content/pages/01-reference/typescript/resources/resources.mdx index dc73216..992c54d 100644 --- a/content/pages/01-reference/typescript/resources/resources.mdx +++ b/content/pages/01-reference/typescript/resources/resources.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx b/content/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx deleted file mode 100644 index c9ff431..0000000 --- a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file diff --git a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx b/content/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx deleted file mode 100644 index 4706590..0000000 --- a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx +++ /dev/null @@ -1,13 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - diff --git a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx b/content/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx deleted file mode 100644 index 36dbc83..0000000 --- a/content/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx +++ /dev/null @@ -1,33 +0,0 @@ - - -```typescript GetStatistics.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const timespan = 944669; - - const result = await sdk.statistics.getStatistics(timespan); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - diff --git a/content/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics.mdx b/content/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics.mdx deleted file mode 100644 index 84ec074..0000000 --- a/content/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/statistics/statistics.mdx b/content/pages/01-reference/typescript/resources/statistics/statistics.mdx deleted file mode 100644 index b75b178..0000000 --- a/content/pages/01-reference/typescript/resources/statistics/statistics.mdx +++ /dev/null @@ -1,12 +0,0 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/typescript/statistics/get_statistics) - Get Media Statistics - ---- - diff --git a/content/pages/01-reference/typescript/security_options/_snippet.mdx b/content/pages/01-reference/typescript/security_options/_snippet.mdx index d9b99ef..d81faaa 100644 --- a/content/pages/01-reference/typescript/security_options/_snippet.mdx +++ b/content/pages/01-reference/typescript/security_options/_snippet.mdx @@ -9,12 +9,13 @@ To authenticate with the API the `accessToken` parameter must be set when initia ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); diff --git a/content/pages/01-reference/typescript/server_options/_snippet.mdx b/content/pages/01-reference/typescript/server_options/_snippet.mdx index 04d0bcf..49601af 100644 --- a/content/pages/01-reference/typescript/server_options/_snippet.mdx +++ b/content/pages/01-reference/typescript/server_options/_snippet.mdx @@ -10,13 +10,14 @@ You can override the default server globally by passing a server index to the `s ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - serverIdx: 0, - accessToken: "", - }); +const plexAPI = new PlexAPI({ + serverIdx: 0, + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); @@ -40,13 +41,14 @@ The default server can also be overridden globally by passing a URL to the `serv ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - serverURL: "{protocol}://{ip}:{port}", - accessToken: "", - }); +const plexAPI = new PlexAPI({ + serverURL: "{protocol}://{ip}:{port}", + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); @@ -62,15 +64,12 @@ The server URL can also be overridden on a per-operation basis, provided a serve ```typescript import { PlexAPI } from "@lukehagar/plexjs"; +const plexAPI = new PlexAPI({ + xPlexClientIdentifier: "Postman", +}); + async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const xPlexClientIdentifier = ""; - const strong = false; - - const result = await sdk.plex.getPin(xPlexClientIdentifier, strong, { + const result = await plexAPI.plex.getPin(false, "Postman", { serverURL: "https://plex.tv/api/v2", }); diff --git a/content/pages/01-reference/typescript/typescript.mdx b/content/pages/01-reference/typescript/typescript.mdx index b133698..a55934b 100644 --- a/content/pages/01-reference/typescript/typescript.mdx +++ b/content/pages/01-reference/typescript/typescript.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/content/types/models/components/http_metadata/go.mdx b/content/types/models/components/http_metadata/go.mdx new file mode 100644 index 0000000..b622740 --- /dev/null +++ b/content/types/models/components/http_metadata/go.mdx @@ -0,0 +1,9 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Response` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) +Raw HTTP response; suitable for custom response parsing + +--- +##### `Request` [*{ `*http.Request` }*](https://pkg.go.dev/net/http#Request) +Raw HTTP request; suitable for debugging + + diff --git a/content/types/models/components/http_metadata/python.mdx b/content/types/models/components/http_metadata/python.mdx new file mode 100644 index 0000000..c564f62 --- /dev/null +++ b/content/types/models/components/http_metadata/python.mdx @@ -0,0 +1,9 @@ +{/* Autogenerated DO NOT EDIT */} +##### `response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) +Raw HTTP response; suitable for custom response parsing + +--- +##### `request` [*{ `requests.Request` }*](https://requests.readthedocs.io/en/latest/api/#requests.Request) +Raw HTTP request; suitable for debugging + + diff --git a/content/types/models/components/http_metadata/typescript.mdx b/content/types/models/components/http_metadata/typescript.mdx deleted file mode 100644 index fa443c1..0000000 --- a/content/types/models/components/http_metadata/typescript.mdx +++ /dev/null @@ -1,9 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `response`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response) -Raw HTTP response; suitable for custom response parsing - ---- -##### `request`: *{`Request`}* -Raw HTTP request; suitable for debugging - - diff --git a/content/types/models/errors/get_statistics_errors/python.mdx b/content/types/models/errors/get_library_items_errors/python.mdx similarity index 100% rename from content/types/models/errors/get_statistics_errors/python.mdx rename to content/types/models/errors/get_library_items_errors/python.mdx diff --git a/content/types/models/errors/get_statistics_errors/typescript.mdx b/content/types/models/errors/get_library_items_errors/typescript.mdx similarity index 100% rename from content/types/models/errors/get_statistics_errors/typescript.mdx rename to content/types/models/errors/get_library_items_errors/typescript.mdx diff --git a/content/types/models/errors/get_library_items_response_body/python.mdx b/content/types/models/errors/get_library_items_response_body/python.mdx new file mode 100644 index 0000000..7c44815 --- /dev/null +++ b/content/types/models/errors/get_library_items_response_body/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `errors` *{`List[errors.GetLibraryItemsErrors]`}* + + import('/content/types/models/errors/get_library_items_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `http_meta` *{`components.HTTPMetadata`}* + + import('/content/types/models/components/http_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/get_statistics_response/typescript.mdx b/content/types/models/errors/get_library_items_response_body/typescript.mdx similarity index 57% rename from content/types/models/operations/get_statistics_response/typescript.mdx rename to content/types/models/errors/get_library_items_response_body/typescript.mdx index f42ceca..727f0b0 100644 --- a/content/types/models/operations/get_statistics_response/typescript.mdx +++ b/content/types/models/errors/get_library_items_response_body/typescript.mdx @@ -2,16 +2,15 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; +##### `errors?`: *{`errors.GetLibraryItemsErrors[]`}* + + import('/content/types/models/errors/get_library_items_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- ##### `httpMeta`: *{`components.HTTPMetadata`}* import('/content/types/models/components/http_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> ---- -##### `object?`: *{`operations.GetStatisticsResponseBody`}* -Media Statistics - - import('/content/types/models/operations/get_statistics_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - diff --git a/content/types/models/errors/get_statistics_response_body/python.mdx b/content/types/models/errors/get_statistics_response_body/python.mdx deleted file mode 100644 index 3527759..0000000 --- a/content/types/models/errors/get_statistics_response_body/python.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `errors` *{`List[errors.GetStatisticsErrors]`}* - - import('/content/types/models/errors/get_statistics_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/errors/search_library_errors/python.mdx b/content/types/models/errors/search_library_errors/python.mdx new file mode 100644 index 0000000..8189f56 --- /dev/null +++ b/content/types/models/errors/search_library_errors/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `code` *{`Optional[float]`}* +
+**Example:** `1001` + +--- +##### `message` *{`Optional[str]`}* +
+**Example:** `User could not be authenticated` + +--- +##### `status` *{`Optional[float]`}* +
+**Example:** `401` + + diff --git a/content/types/models/errors/search_library_errors/typescript.mdx b/content/types/models/errors/search_library_errors/typescript.mdx new file mode 100644 index 0000000..9ed36a5 --- /dev/null +++ b/content/types/models/errors/search_library_errors/typescript.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `code?`: *{`number`}* +
+**Example:** `1001` + +--- +##### `message?`: *{`string`}* +
+**Example:** `User could not be authenticated` + +--- +##### `status?`: *{`number`}* +
+**Example:** `401` + + diff --git a/content/types/models/errors/search_library_response_body/python.mdx b/content/types/models/errors/search_library_response_body/python.mdx new file mode 100644 index 0000000..4391a16 --- /dev/null +++ b/content/types/models/errors/search_library_response_body/python.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `errors` *{`List[errors.SearchLibraryErrors]`}* + + import('/content/types/models/errors/search_library_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `http_meta` *{`components.HTTPMetadata`}* + + import('/content/types/models/components/http_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/errors/get_statistics_response_body/typescript.mdx b/content/types/models/errors/search_library_response_body/typescript.mdx similarity index 80% rename from content/types/models/errors/get_statistics_response_body/typescript.mdx rename to content/types/models/errors/search_library_response_body/typescript.mdx index 529505e..bfef990 100644 --- a/content/types/models/errors/get_statistics_response_body/typescript.mdx +++ b/content/types/models/errors/search_library_response_body/typescript.mdx @@ -2,9 +2,9 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `errors?`: *{`errors.GetStatisticsErrors[]`}* +##### `errors?`: *{`errors.SearchLibraryErrors[]`}* - import('/content/types/models/errors/get_statistics_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/errors/search_library_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/pages/01-reference/python/resources/plex/get_token/_parameters.mdx b/content/types/models/internal/globals/python.mdx similarity index 62% rename from content/pages/01-reference/python/resources/plex/get_token/_parameters.mdx rename to content/types/models/internal/globals/python.mdx index 53d81c7..b12140e 100644 --- a/content/pages/01-reference/python/resources/plex/get_token/_parameters.mdx +++ b/content/types/models/internal/globals/python.mdx @@ -1,15 +1,10 @@ {/* Autogenerated DO NOT EDIT */} -##### `pin_id` *{`str`}* -The PinID to retrieve an access token for - ---- ##### `x_plex_client_identifier` *{`str`}* The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) +
+**Example:** `Postman` ---- -##### `server_url` *{`Optional[str]`}* -An optional server URL to use. diff --git a/content/types/models/operations/account/go.mdx b/content/types/models/operations/account/go.mdx deleted file mode 100644 index 57e0277..0000000 --- a/content/types/models/operations/account/go.mdx +++ /dev/null @@ -1,41 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ID` *{`*int`}* -
-**Example:** `238960586` - ---- -##### `Key` *{`*string`}* -
-**Example:** `/accounts/238960586` - ---- -##### `Name` *{`*string`}* -
-**Example:** `Diane` - ---- -##### `DefaultAudioLanguage` *{`*string`}* -
-**Example:** `en` - ---- -##### `AutoSelectAudio` *{`*bool`}* -
-**Example:** `true` - ---- -##### `DefaultSubtitleLanguage` *{`*string`}* -
-**Example:** `en` - ---- -##### `SubtitleMode` *{`*int`}* -
-**Example:** `1` - ---- -##### `Thumb` *{`*string`}* -
-**Example:** `https://plex.tv/users/50d83634246da1de/avatar?c=1707110967` - - diff --git a/content/types/models/operations/account/python.mdx b/content/types/models/operations/account/python.mdx deleted file mode 100644 index efcaf4f..0000000 --- a/content/types/models/operations/account/python.mdx +++ /dev/null @@ -1,41 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `id` *{`Optional[int]`}* -
-**Example:** `238960586` - ---- -##### `key` *{`Optional[str]`}* -
-**Example:** `/accounts/238960586` - ---- -##### `name` *{`Optional[str]`}* -
-**Example:** `Diane` - ---- -##### `default_audio_language` *{`Optional[str]`}* -
-**Example:** `en` - ---- -##### `auto_select_audio` *{`Optional[bool]`}* -
-**Example:** `true` - ---- -##### `default_subtitle_language` *{`Optional[str]`}* -
-**Example:** `en` - ---- -##### `subtitle_mode` *{`Optional[int]`}* -
-**Example:** `1` - ---- -##### `thumb` *{`Optional[str]`}* -
-**Example:** `https://plex.tv/users/50d83634246da1de/avatar?c=1707110967` - - diff --git a/content/types/models/operations/account/typescript.mdx b/content/types/models/operations/account/typescript.mdx deleted file mode 100644 index 70fc6e2..0000000 --- a/content/types/models/operations/account/typescript.mdx +++ /dev/null @@ -1,41 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `id?`: *{`number`}* -
-**Example:** `238960586` - ---- -##### `key?`: *{`string`}* -
-**Example:** `/accounts/238960586` - ---- -##### `name?`: *{`string`}* -
-**Example:** `Diane` - ---- -##### `defaultAudioLanguage?`: *{`string`}* -
-**Example:** `en` - ---- -##### `autoSelectAudio?`: *{`boolean`}* -
-**Example:** `true` - ---- -##### `defaultSubtitleLanguage?`: *{`string`}* -
-**Example:** `en` - ---- -##### `subtitleMode?`: *{`number`}* -
-**Example:** `1` - ---- -##### `thumb?`: *{`string`}* -
-**Example:** `https://plex.tv/users/50d83634246da1de/avatar?c=1707110967` - - diff --git a/content/types/models/operations/get_pin_globals/go.mdx b/content/types/models/operations/get_pin_globals/go.mdx new file mode 100644 index 0000000..0dc45e6 --- /dev/null +++ b/content/types/models/operations/get_pin_globals/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `XPlexClientIdentifier` *{`string`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/get_pin_globals/python.mdx b/content/types/models/operations/get_pin_globals/python.mdx new file mode 100644 index 0000000..b12140e --- /dev/null +++ b/content/types/models/operations/get_pin_globals/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `x_plex_client_identifier` *{`str`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/get_pin_globals/typescript.mdx b/content/types/models/operations/get_pin_globals/typescript.mdx new file mode 100644 index 0000000..9ca4c6c --- /dev/null +++ b/content/types/models/operations/get_pin_globals/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `xPlexClientIdentifier`: *{`string`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/get_statistics_device/go.mdx b/content/types/models/operations/get_statistics_device/go.mdx deleted file mode 100644 index 331ef8e..0000000 --- a/content/types/models/operations/get_statistics_device/go.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ID` *{`*int`}* -
-**Example:** `208` - ---- -##### `Name` *{`*string`}* -
-**Example:** `Roku Express` - ---- -##### `Platform` *{`*string`}* -
-**Example:** `Roku` - ---- -##### `ClientIdentifier` *{`*string`}* -
-**Example:** `793095d235660625108ef785cc7646e9` - ---- -##### `CreatedAt` *{`*int`}* -
-**Example:** `1706470556` - - diff --git a/content/types/models/operations/get_statistics_device/python.mdx b/content/types/models/operations/get_statistics_device/python.mdx deleted file mode 100644 index 32c9f7b..0000000 --- a/content/types/models/operations/get_statistics_device/python.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `id` *{`Optional[int]`}* -
-**Example:** `208` - ---- -##### `name` *{`Optional[str]`}* -
-**Example:** `Roku Express` - ---- -##### `platform` *{`Optional[str]`}* -
-**Example:** `Roku` - ---- -##### `client_identifier` *{`Optional[str]`}* -
-**Example:** `793095d235660625108ef785cc7646e9` - ---- -##### `created_at` *{`Optional[int]`}* -
-**Example:** `1706470556` - - diff --git a/content/types/models/operations/get_statistics_device/typescript.mdx b/content/types/models/operations/get_statistics_device/typescript.mdx deleted file mode 100644 index f378e46..0000000 --- a/content/types/models/operations/get_statistics_device/typescript.mdx +++ /dev/null @@ -1,26 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `id?`: *{`number`}* -
-**Example:** `208` - ---- -##### `name?`: *{`string`}* -
-**Example:** `Roku Express` - ---- -##### `platform?`: *{`string`}* -
-**Example:** `Roku` - ---- -##### `clientIdentifier?`: *{`string`}* -
-**Example:** `793095d235660625108ef785cc7646e9` - ---- -##### `createdAt?`: *{`number`}* -
-**Example:** `1706470556` - - diff --git a/content/types/models/operations/get_statistics_media_container/go.mdx b/content/types/models/operations/get_statistics_media_container/go.mdx deleted file mode 100644 index df77ec4..0000000 --- a/content/types/models/operations/get_statistics_media_container/go.mdx +++ /dev/null @@ -1,33 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `Size` *{`*int`}* -
-**Example:** `5497` - ---- -##### `Device` *{`[]operations.GetStatisticsDevice`}* -
-**Example:** `[{"clientIdentifier":"793095d235660625108ef785cc7646e9","createdAt":1706470556,"id":208,"name":"Roku Express","platform":"Roku"}]` - - import('/content/types/models/operations/get_statistics_device/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `Account` *{`[]operations.Account`}* -
-**Example:** `[{"autoSelectAudio":true,"defaultAudioLanguage":"en","defaultSubtitleLanguage":"en","id":238960586,"key":"/accounts/238960586","name":"Diane","subtitleMode":1,"thumb":"https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"}]` - - import('/content/types/models/operations/account/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `StatisticsMedia` *{`[]operations.StatisticsMedia`}* -
-**Example:** `[{"accountID":1,"at":1707141600,"count":1,"deviceID":13,"duration":1555,"metadataType":4,"timespan":4}]` - - import('/content/types/models/operations/statistics_media/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_media_container/python.mdx b/content/types/models/operations/get_statistics_media_container/python.mdx deleted file mode 100644 index 91f92dc..0000000 --- a/content/types/models/operations/get_statistics_media_container/python.mdx +++ /dev/null @@ -1,33 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `size` *{`Optional[int]`}* -
-**Example:** `5497` - ---- -##### `device` *{`List[operations.GetStatisticsDevice]`}* -
-**Example:** `[{"clientIdentifier":"793095d235660625108ef785cc7646e9","createdAt":1706470556,"id":208,"name":"Roku Express","platform":"Roku"}]` - - import('/content/types/models/operations/get_statistics_device/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `account` *{`List[operations.Account]`}* -
-**Example:** `[{"autoSelectAudio":true,"defaultAudioLanguage":"en","defaultSubtitleLanguage":"en","id":238960586,"key":"/accounts/238960586","name":"Diane","subtitleMode":1,"thumb":"https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"}]` - - import('/content/types/models/operations/account/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `statistics_media` *{`List[operations.StatisticsMedia]`}* -
-**Example:** `[{"accountID":1,"at":1707141600,"count":1,"deviceID":13,"duration":1555,"metadataType":4,"timespan":4}]` - - import('/content/types/models/operations/statistics_media/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_media_container/typescript.mdx b/content/types/models/operations/get_statistics_media_container/typescript.mdx deleted file mode 100644 index c2d16ad..0000000 --- a/content/types/models/operations/get_statistics_media_container/typescript.mdx +++ /dev/null @@ -1,33 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `size?`: *{`number`}* -
-**Example:** `5497` - ---- -##### `device?`: *{`operations.GetStatisticsDevice[]`}* -
-**Example:** `[{"clientIdentifier":"793095d235660625108ef785cc7646e9","createdAt":1706470556,"id":208,"name":"Roku Express","platform":"Roku"}]` - - import('/content/types/models/operations/get_statistics_device/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `account?`: *{`operations.Account[]`}* -
-**Example:** `[{"autoSelectAudio":true,"defaultAudioLanguage":"en","defaultSubtitleLanguage":"en","id":238960586,"key":"/accounts/238960586","name":"Diane","subtitleMode":1,"thumb":"https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"}]` - - import('/content/types/models/operations/account/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `statisticsMedia?`: *{`operations.StatisticsMedia[]`}* -
-**Example:** `[{"accountID":1,"at":1707141600,"count":1,"deviceID":13,"duration":1555,"metadataType":4,"timespan":4}]` - - import('/content/types/models/operations/statistics_media/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_request/go.mdx b/content/types/models/operations/get_statistics_request/go.mdx deleted file mode 100644 index b341fee..0000000 --- a/content/types/models/operations/get_statistics_request/go.mdx +++ /dev/null @@ -1,7 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `Timespan` *{`*int64`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - - diff --git a/content/types/models/operations/get_statistics_request/python.mdx b/content/types/models/operations/get_statistics_request/python.mdx deleted file mode 100644 index 02cdda4..0000000 --- a/content/types/models/operations/get_statistics_request/python.mdx +++ /dev/null @@ -1,7 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `timespan` *{`Optional[int]`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - - diff --git a/content/types/models/operations/get_statistics_request/typescript.mdx b/content/types/models/operations/get_statistics_request/typescript.mdx deleted file mode 100644 index d6788f0..0000000 --- a/content/types/models/operations/get_statistics_request/typescript.mdx +++ /dev/null @@ -1,7 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `timespan?`: *{`number`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - - diff --git a/content/types/models/operations/get_statistics_response/go.mdx b/content/types/models/operations/get_statistics_response/go.mdx deleted file mode 100644 index 5a0391b..0000000 --- a/content/types/models/operations/get_statistics_response/go.mdx +++ /dev/null @@ -1,23 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `ContentType` *{`string`}* -HTTP response content type for this operation - ---- -##### `StatusCode` *{`int`}* -HTTP response status code for this operation - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - ---- -##### `Object` *{`*operations.GetStatisticsResponseBody`}* -Media Statistics - - import('/content/types/models/operations/get_statistics_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_response/python.mdx b/content/types/models/operations/get_statistics_response/python.mdx deleted file mode 100644 index 023dc4b..0000000 --- a/content/types/models/operations/get_statistics_response/python.mdx +++ /dev/null @@ -1,23 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `content_type` *{`str`}* -HTTP response content type for this operation - ---- -##### `status_code` *{`int`}* -HTTP response status code for this operation - ---- -##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response) -Raw HTTP response; suitable for custom response parsing - ---- -##### `object` *{`Optional[operations.GetStatisticsResponseBody]`}* -Media Statistics - - import('/content/types/models/operations/get_statistics_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_response_body/go.mdx b/content/types/models/operations/get_statistics_response_body/go.mdx deleted file mode 100644 index 2c67e35..0000000 --- a/content/types/models/operations/get_statistics_response_body/go.mdx +++ /dev/null @@ -1,10 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `MediaContainer` *{`*operations.GetStatisticsMediaContainer`}* - - import('/content/types/models/operations/get_statistics_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_response_body/python.mdx b/content/types/models/operations/get_statistics_response_body/python.mdx deleted file mode 100644 index 185bbe6..0000000 --- a/content/types/models/operations/get_statistics_response_body/python.mdx +++ /dev/null @@ -1,10 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `media_container` *{`Optional[operations.GetStatisticsMediaContainer]`}* - - import('/content/types/models/operations/get_statistics_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_statistics_response_body/typescript.mdx b/content/types/models/operations/get_statistics_response_body/typescript.mdx deleted file mode 100644 index 28616ba..0000000 --- a/content/types/models/operations/get_statistics_response_body/typescript.mdx +++ /dev/null @@ -1,10 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `mediaContainer?`: *{`operations.GetStatisticsMediaContainer`}* - - import('/content/types/models/operations/get_statistics_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - - diff --git a/content/types/models/operations/get_token_globals/go.mdx b/content/types/models/operations/get_token_globals/go.mdx new file mode 100644 index 0000000..0dc45e6 --- /dev/null +++ b/content/types/models/operations/get_token_globals/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `XPlexClientIdentifier` *{`string`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/get_token_globals/python.mdx b/content/types/models/operations/get_token_globals/python.mdx new file mode 100644 index 0000000..b12140e --- /dev/null +++ b/content/types/models/operations/get_token_globals/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `x_plex_client_identifier` *{`str`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/get_token_globals/typescript.mdx b/content/types/models/operations/get_token_globals/typescript.mdx new file mode 100644 index 0000000..9ca4c6c --- /dev/null +++ b/content/types/models/operations/get_token_globals/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `xPlexClientIdentifier`: *{`string`}* +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + + diff --git a/content/types/models/operations/statistics_media/go.mdx b/content/types/models/operations/statistics_media/go.mdx deleted file mode 100644 index d033c77..0000000 --- a/content/types/models/operations/statistics_media/go.mdx +++ /dev/null @@ -1,36 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `AccountID` *{`*int`}* -
-**Example:** `1` - ---- -##### `DeviceID` *{`*int`}* -
-**Example:** `13` - ---- -##### `Timespan` *{`*int`}* -
-**Example:** `4` - ---- -##### `At` *{`*int`}* -
-**Example:** `1707141600` - ---- -##### `MetadataType` *{`*int`}* -
-**Example:** `4` - ---- -##### `Count` *{`*int`}* -
-**Example:** `1` - ---- -##### `Duration` *{`*int`}* -
-**Example:** `1555` - - diff --git a/content/types/models/operations/statistics_media/python.mdx b/content/types/models/operations/statistics_media/python.mdx deleted file mode 100644 index 1f3d41b..0000000 --- a/content/types/models/operations/statistics_media/python.mdx +++ /dev/null @@ -1,36 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `account_id` *{`Optional[int]`}* -
-**Example:** `1` - ---- -##### `device_id` *{`Optional[int]`}* -
-**Example:** `13` - ---- -##### `timespan` *{`Optional[int]`}* -
-**Example:** `4` - ---- -##### `at` *{`Optional[int]`}* -
-**Example:** `1707141600` - ---- -##### `metadata_type` *{`Optional[int]`}* -
-**Example:** `4` - ---- -##### `count` *{`Optional[int]`}* -
-**Example:** `1` - ---- -##### `duration` *{`Optional[int]`}* -
-**Example:** `1555` - - diff --git a/content/types/models/operations/statistics_media/typescript.mdx b/content/types/models/operations/statistics_media/typescript.mdx deleted file mode 100644 index 5e8a240..0000000 --- a/content/types/models/operations/statistics_media/typescript.mdx +++ /dev/null @@ -1,36 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -##### `accountID?`: *{`number`}* -
-**Example:** `1` - ---- -##### `deviceID?`: *{`number`}* -
-**Example:** `13` - ---- -##### `timespan?`: *{`number`}* -
-**Example:** `4` - ---- -##### `at?`: *{`number`}* -
-**Example:** `1707141600` - ---- -##### `metadataType?`: *{`number`}* -
-**Example:** `4` - ---- -##### `count?`: *{`number`}* -
-**Example:** `1` - ---- -##### `duration?`: *{`number`}* -
-**Example:** `1555` - - diff --git a/content/types/models/sdkerrors/get_statistics_errors/go.mdx b/content/types/models/sdkerrors/get_library_items_errors/go.mdx similarity index 100% rename from content/types/models/sdkerrors/get_statistics_errors/go.mdx rename to content/types/models/sdkerrors/get_library_items_errors/go.mdx diff --git a/content/types/models/sdkerrors/get_library_items_response_body/go.mdx b/content/types/models/sdkerrors/get_library_items_response_body/go.mdx new file mode 100644 index 0000000..5a98d8d --- /dev/null +++ b/content/types/models/sdkerrors/get_library_items_response_body/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Errors` *{`[]sdkerrors.GetLibraryItemsErrors`}* + + import('/content/types/models/sdkerrors/get_library_items_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `HTTPMeta` *{`components.HTTPMetadata`}* + + import('/content/types/models/components/http_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/sdkerrors/get_statistics_response_body/go.mdx b/content/types/models/sdkerrors/get_statistics_response_body/go.mdx deleted file mode 100644 index 41abe90..0000000 --- a/content/types/models/sdkerrors/get_statistics_response_body/go.mdx +++ /dev/null @@ -1,14 +0,0 @@ -{/* Autogenerated DO NOT EDIT */} -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### `Errors` *{`[]sdkerrors.GetStatisticsErrors`}* - - import('/content/types/models/sdkerrors/get_statistics_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> - - ---- -##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response) -Raw HTTP response; suitable for custom response parsing - - diff --git a/content/types/models/sdkerrors/search_library_errors/go.mdx b/content/types/models/sdkerrors/search_library_errors/go.mdx new file mode 100644 index 0000000..e4612a8 --- /dev/null +++ b/content/types/models/sdkerrors/search_library_errors/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `Code` *{`*float64`}* +
+**Example:** `1001` + +--- +##### `Message` *{`*string`}* +
+**Example:** `User could not be authenticated` + +--- +##### `Status` *{`*float64`}* +
+**Example:** `401` + + diff --git a/content/types/models/sdkerrors/search_library_response_body/go.mdx b/content/types/models/sdkerrors/search_library_response_body/go.mdx new file mode 100644 index 0000000..42669b1 --- /dev/null +++ b/content/types/models/sdkerrors/search_library_response_body/go.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Errors` *{`[]sdkerrors.SearchLibraryErrors`}* + + import('/content/types/models/sdkerrors/search_library_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + +--- +##### `HTTPMeta` *{`components.HTTPMetadata`}* + + import('/content/types/models/components/http_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/operations/add_playlist_contents_media_container/curl.mdx b/content/types/operations/add_playlist_contents_media_container/curl.mdx index 376a50e..4dce791 100644 --- a/content/types/operations/add_playlist_contents_media_container/curl.mdx +++ b/content/types/operations/add_playlist_contents_media_container/curl.mdx @@ -15,7 +15,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1705716458,"composite":"/playlists/94/composite/1705800070","duration":423000,"guid":"com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2","key":"/playlists/94/items","leafCount":3,"playlistType":"video","ratingKey":"94","smart":false,"summary":"One of my great playlists","title":"A great playlist","type":"playlist","updatedAt":1705800070}]` diff --git a/content/types/operations/apply_updates_request/curl.mdx b/content/types/operations/apply_updates_request/curl.mdx index 8602ebf..99993c3 100644 --- a/content/types/operations/apply_updates_request/curl.mdx +++ b/content/types/operations/apply_updates_request/curl.mdx @@ -4,6 +4,8 @@ import Labels from "/src/lib/labels"; ##### `tonight` _enumeration (optional)_ Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install +
+**Example:** `1` import('/content/types/operations/tonight/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> @@ -11,6 +13,8 @@ Indicate that you want the update to run during the next Butler execution. Omitt --- ##### `skip` _enumeration (optional)_ Indicate that the latest version should be marked as skipped. The \ entry for this version will have the `state` set to `skipped`. +
+**Example:** `1` import('/content/types/operations/skip/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/operations/cancel_server_activities_request/curl.mdx b/content/types/operations/cancel_server_activities_request/curl.mdx index 779c58c..6f91758 100644 --- a/content/types/operations/cancel_server_activities_request/curl.mdx +++ b/content/types/operations/cancel_server_activities_request/curl.mdx @@ -1,5 +1,7 @@ {/* Autogenerated DO NOT EDIT */} ##### `activityUUID` _string_ The UUID of the activity to cancel. +
+**Example:** `25b71ed5-0f9d-461c-baa7-d404e9e10d3e` diff --git a/content/types/operations/check_for_updates_request/curl.mdx b/content/types/operations/check_for_updates_request/curl.mdx index 182b805..32dc590 100644 --- a/content/types/operations/check_for_updates_request/curl.mdx +++ b/content/types/operations/check_for_updates_request/curl.mdx @@ -4,6 +4,8 @@ import Labels from "/src/lib/labels"; ##### `download` _enumeration (optional)_ Indicate that you want to start download any updates found. +
+**Example:** `1` import('/content/types/operations/download/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/operations/create_playlist_media_container/curl.mdx b/content/types/operations/create_playlist_media_container/curl.mdx index f0a7be2..5f6596a 100644 --- a/content/types/operations/create_playlist_media_container/curl.mdx +++ b/content/types/operations/create_playlist_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1705719589,"composite":"/playlists/96/composite/1705724593","duration":141000,"guid":"com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55","icon":"playlist://image.smart","key":"/playlists/96/items","lastViewedAt":1705719589,"leafCount":1,"playlistType":"video","ratingKey":"96","smart":false,"summary":"What a great playlist","title":"A Great Playlist","type":"playlist","updatedAt":1705724593,"viewCount":1}]` diff --git a/content/types/operations/field_type/curl.mdx b/content/types/operations/field_type/curl.mdx index 68a645e..ebdceef 100644 --- a/content/types/operations/field_type/curl.mdx +++ b/content/types/operations/field_type/curl.mdx @@ -5,7 +5,5 @@ --- ##### `operator` _array (optional)_ -
-**Example:** `[{"key":"=","title":"is"}]` diff --git a/content/types/operations/get_global_hubs_media_container/curl.mdx b/content/types/operations/get_global_hubs_media_container/curl.mdx index 560a12f..314857f 100644 --- a/content/types/operations/get_global_hubs_media_container/curl.mdx +++ b/content/types/operations/get_global_hubs_media_container/curl.mdx @@ -15,7 +15,5 @@ --- ##### `hub` _array (optional)_ -
-**Example:** `[{"Metadata":[{"addedAt":1655309388,"composite":"/playlists/50768/composite/1704333758","duration":42864000,"guid":"com.plexapp.agents.none://81658e0d-cd4e-4c73-abb9-832b2ae2037b","icon":"playlist://image.smart","key":"/playlists/50768/items","lastViewedAt":1705329935,"leafCount":178,"playlistType":"audio","ratingKey":"50768","smart":true,"summary":"All your highly rated tracks, in one convenient place.","title":"❤️ Tracks","titleSort":"Tracks","type":"playlist","updatedAt":1704333758,"viewCount":47},{"addedAt":1697993545,"composite":"/playlists/65523/composite/1698597932","duration":4864000,"guid":"com.plexapp.agents.none://1bcdd596-892b-4856-9f28-b4338c439300","key":"/playlists/65523/items","lastViewedAt":1698597949,"leafCount":19,"playlistType":"audio","ratingKey":"65523","smart":false,"summary":"","title":"Car Rides","type":"playlist","updatedAt":1698597932,"viewCount":2},{"addedAt":1679616785,"composite":"/playlists/58188/composite/1680825595","duration":12522000,"guid":"com.plexapp.agents.none://8f0441d3-2a28-4644-a2f1-b7deeb290dff","key":"/playlists/58188/items","lastViewedAt":1680825596,"leafCount":56,"playlistType":"audio","ratingKey":"58188","smart":false,"summary":"","title":"Workout","type":"playlist","updatedAt":1680825595,"viewCount":4},{"addedAt":1673372306,"composite":"/playlists/57341/composite/1673372385","duration":19119000,"guid":"com.plexapp.agents.none://bf8778c3-20a3-4619-8eb0-3c172c18ffd6","key":"/playlists/57341/items","lastViewedAt":1673372306,"leafCount":3,"playlistType":"video","ratingKey":"57341","smart":false,"summary":"","title":"January Movie Day","type":"playlist","updatedAt":1673372385,"viewCount":1},{"addedAt":1671197078,"composite":"/playlists/57302/composite/1671205874","duration":23040000,"guid":"com.plexapp.agents.none://f25064ed-05bb-4bcf-b70c-ed7514b70929","key":"/playlists/57302/items","lastViewedAt":1671206853,"leafCount":3,"playlistType":"video","ratingKey":"57302","smart":false,"summary":"","title":"December Movie Day","type":"playlist","updatedAt":1671205874,"viewCount":2},{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","type":"playlist","updatedAt":1668787730,"viewCount":2}],"context":"hub.home.playlists","hubIdentifier":"home.playlists","hubKey":"/library/metadata/50768,65523,58188,57341,57302,57070","key":"/playlists/all?type=15\u0026sort=lastViewedAt:desc\u0026playlistType=video,audio","more":true,"promoted":true,"size":6,"style":"shelf","title":"Recent Playlists","type":"playlist"}]` diff --git a/content/types/operations/get_libraries_directory/curl.mdx b/content/types/operations/get_libraries_directory/curl.mdx index f03733b..c2357a2 100644 --- a/content/types/operations/get_libraries_directory/curl.mdx +++ b/content/types/operations/get_libraries_directory/curl.mdx @@ -100,7 +100,5 @@ --- ##### `location` _array (optional)_ -
-**Example:** `[{"id":1,"path":"/movies"}]` diff --git a/content/types/operations/get_libraries_media_container/curl.mdx b/content/types/operations/get_libraries_media_container/curl.mdx index 39cb7af..b45c0f7 100644 --- a/content/types/operations/get_libraries_media_container/curl.mdx +++ b/content/types/operations/get_libraries_media_container/curl.mdx @@ -15,7 +15,5 @@ --- ##### `directory` _array (optional)_ -
-**Example:** `[{"Location":[{"id":1,"path":"/movies"}],"agent":"tv.plex.agents.movie","allowSync":true,"art":"/:/resources/movie-fanart.jpg","composite":"/library/sections/1/composite/1705615584","content":true,"contentChangedAt":3192854,"createdAt":1654131312,"directory":true,"filters":true,"hidden":0,"key":"1","language":"en-US","refreshing":false,"scannedAt":1705615584,"scanner":"Plex Movie","thumb":"/:/resources/movie.png","title":"Movies","type":"movie","updatedAt":1705615634,"uuid":"322a231a-b7f7-49f5-920f-14c61199cd30"}]` diff --git a/content/types/operations/get_library_hubs_hub/curl.mdx b/content/types/operations/get_library_hubs_hub/curl.mdx index 79fccf3..b521f12 100644 --- a/content/types/operations/get_library_hubs_hub/curl.mdx +++ b/content/types/operations/get_library_hubs_hub/curl.mdx @@ -45,8 +45,6 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","skipCount":1,"studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}]` --- ##### `promoted` _boolean (optional)_ diff --git a/content/types/operations/get_library_hubs_media/curl.mdx b/content/types/operations/get_library_hubs_media/curl.mdx index ea422e1..51c6944 100644 --- a/content/types/operations/get_library_hubs_media/curl.mdx +++ b/content/types/operations/get_library_hubs_media/curl.mdx @@ -80,7 +80,5 @@ --- ##### `part` _array (optional)_ -
-**Example:** `[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}]` diff --git a/content/types/operations/get_library_hubs_media_container/curl.mdx b/content/types/operations/get_library_hubs_media_container/curl.mdx index 6c983b1..011eae4 100644 --- a/content/types/operations/get_library_hubs_media_container/curl.mdx +++ b/content/types/operations/get_library_hubs_media_container/curl.mdx @@ -30,7 +30,5 @@ --- ##### `hub` _array (optional)_ -
-**Example:** `[{"Metadata":[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Ceyda Torun"}],"Genre":[{"tag":"Documentary"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":4736174,"file":"/movies/Kedi (2017)/Kedi (2017) 1080p x264.mp4","has64bitOffsets":false,"id":129778,"key":"/library/parts/129778/1702586883/file.mp4","optimizedForStreaming":false,"size":1410810905,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2377,"container":"mp4","duration":4736174,"has64bitOffsets":false,"height":1080,"id":129531,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Bülent Üstün"}],"addedAt":1702586905,"art":"/library/metadata/66485/art/1702586907","audienceRating":8.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"Not Rated","duration":4736174,"guid":"plex://movie/5d776c3251dd69001fe38bb4","key":"/library/metadata/66485","lastViewedAt":1705786111,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2017-02-10T00:00:00Z","primaryExtraKey":"/library/metadata/66486","rating":9.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66485","studio":"Termite Films","summary":"A profile of an ancient city and its unique people, seen through the eyes of the most mysterious and beloved animal humans have ever known, the Cat.","tagline":"A cat meowing at your feet, looking up at you, is life smiling at you...","thumb":"/library/metadata/66485/thumb/1702586907","title":"Kedi","type":"movie","updatedAt":1702586907,"viewCount":2,"year":2017},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Duwayne Dunham"}],"Genre":[{"tag":"Adventure"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":5065775,"file":"/movies/Homeward Bound The Incredible Journey (1993)/Homeward Bound The Incredible Journey (1993) [BluRay] [1080p] [YTS.LT].mp4","has64bitOffsets":false,"id":129250,"key":"/library/parts/129250/1700434864/file.mp4","optimizedForStreaming":true,"size":1550855333,"videoProfile":"high"}],"aspectRatio":1.85,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2444,"container":"mp4","duration":5065775,"has64bitOffsets":false,"height":1024,"id":129003,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1904}],"Role":[{"tag":"Michael J. Fox"},{"tag":"Sally Field"},{"tag":"Don Ameche"}],"Writer":[{"tag":"Caroline Thompson"},{"tag":"Linda Woolverton"}],"addedAt":1700434925,"art":"/library/metadata/66098/art/1703148781","audienceRating":7.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"G","duration":5065775,"guid":"plex://movie/5d9f34f4adeb7a0021ce020f","key":"/library/metadata/66098","lastViewedAt":1705709811,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"1993-02-12T00:00:00Z","primaryExtraKey":"/library/metadata/66099","rating":8.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"66098","studio":"Touchwood Pacific Partners 1","summary":"A fun-loving American bulldog pup, a hilarious Himalayan cat, and a wise old golden retriever embark on a long trek through the rugged wilderness of the Sierra Nevada mountains in a quest to reach home and their beloved owners.","tagline":"In the classic tradition of Walt Disney Pictures comes a story about courage, adventure and friendship.","thumb":"/library/metadata/66098/thumb/1703148781","title":"Homeward Bound: The Incredible Journey","type":"movie","updatedAt":1703148781,"viewCount":2,"year":1993},{"Country":[{"tag":"Canada"},{"tag":"Ireland"}],"Director":[{"tag":"Matt Stawski"}],"Genre":[{"tag":"Comedy"},{"tag":"Family"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mkv","duration":4459050,"file":"/movies/Blue's Big City Adventure (2022)/Blues.Big.City.Adventure.2022.2160p.4K.WEB.x265.10bit.AAC5.1-[YTS.MX].mkv","id":115478,"key":"/library/parts/115478/1669671340/file.mkv","size":3560750664,"videoProfile":"main 10"}],"aspectRatio":1.78,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":6384,"container":"mkv","duration":4459050,"height":2160,"id":115470,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Joshua Dela Cruz"},{"tag":"Steve Burns"},{"tag":"Donovan Patton"}],"Writer":[{"tag":"Traci Paige Johnson"},{"tag":"Todd Kessler"}],"addedAt":1669671356,"art":"/library/metadata/57249/art/1704274800","audienceRating":8.6,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"TV-Y","duration":4459050,"guid":"plex://movie/60eff7d3e22797002c55c1cc","key":"/library/metadata/57249","lastViewedAt":1705681955,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2022-11-18T00:00:00Z","primaryExtraKey":"/library/metadata/57250","rating":8.3,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"57249","skipCount":1,"studio":"Nickelodeon Movies","summary":"Josh and Blue skidoo to New York City to audition for Rainbow Puppy's Broadway musical, but they get lost when Josh accidentally left his Handy Dandy Notebook at home. This leads to a game of Blue's Clues to figure out where the audition is. Meanwhile, Tickety Tock and her friends go to New York City to find Josh and Blue and get to the audition with help from Joe and Steve.","tagline":"All They Need is You.","thumb":"/library/metadata/57249/thumb/1704274800","title":"Blue's Big City Adventure","type":"movie","updatedAt":1704274800,"viewCount":8,"year":2022},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Dan Scanlon"}],"Genre":[{"tag":"Animation"},{"tag":"Comedy"}],"Media":[{"Part":[{"audioProfile":"ma","container":"mkv","duration":6141428,"file":"/movies/Onward (2020)/Onward (2020) Bluray-1080p.mkv","id":29291,"key":"/library/parts/29291/1589237130/file.mkv","size":8426669232,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":8,"audioCodec":"dca-ma","audioProfile":"ma","bitrate":10977,"container":"mkv","duration":6141428,"height":804,"id":29291,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6142006,"file":"/movies/Onward (2020)/Onward (2020) WEBRip-1080p.mp4","has64bitOffsets":false,"id":29315,"key":"/library/parts/29315/1629002847/file.mp4","optimizedForStreaming":true,"size":2026154995,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2639,"container":"mp4","duration":6142006,"has64bitOffsets":false,"height":800,"id":29315,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Tom Holland"},{"tag":"Chris Pratt"},{"tag":"Julia Louis-Dreyfus"}],"Writer":[{"tag":"Kelsey Mann"},{"tag":"Dan Scanlon"}],"addedAt":1589237130,"art":"/library/metadata/11449/art/1705224000","audienceRating":9.5,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG","duration":6141428,"guid":"plex://movie/5d776edfad5437001f803cf9","key":"/library/metadata/11449","lastViewedAt":1705543126,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2020-03-04T00:00:00Z","primaryExtraKey":"/library/metadata/11470","rating":8.8,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"11449","studio":"Walt Disney Pictures","summary":"In a magical world full of technological advances, elven brothers Ian and Barley Lightfoot set out on an adventure to resurrect their late father for a day.","tagline":"Their quest begineth.","thumb":"/library/metadata/11449/thumb/1705224000","title":"Onward","type":"movie","updatedAt":1705224000,"viewCount":3,"year":2020},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Chris Buck"},{"tag":"Jennifer Lee"}],"Genre":[{"tag":"Adventure"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6194042,"file":"/movies/Frozen II (2019)/Frozen II (2019) Bluray-1080p.mp4","has64bitOffsets":false,"id":14954,"key":"/library/parts/14954/1588207762/file.mp4","optimizedForStreaming":true,"size":1969230037,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2538,"container":"mp4","duration":6194042,"has64bitOffsets":false,"height":800,"id":14954,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920},{"Part":[{"audioProfile":"lc","container":"mp4","duration":6244271,"file":"/movies/Frozen II (2019)/Frozen II (2019) WEBRip-1080p.mp4","has64bitOffsets":false,"id":14999,"key":"/library/parts/14999/1629001526/file.mp4","optimizedForStreaming":true,"size":1983357282,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":6,"audioCodec":"aac","audioProfile":"lc","bitrate":2536,"container":"mp4","duration":6244271,"has64bitOffsets":false,"height":800,"id":14999,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Idina Menzel"},{"tag":"Kristen Bell"},{"tag":"Josh Gad"}],"Writer":[{"tag":"Chris Buck"},{"tag":"Hans Christian Andersen"}],"addedAt":1588207762,"art":"/library/metadata/5858/art/1704621922","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6194042,"guid":"plex://movie/5d776b85594b2b001e6dc641","key":"/library/metadata/5858","lastViewedAt":1705337663,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2019-11-20T00:00:00Z","primaryExtraKey":"/library/metadata/5892","rating":7.7,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"5858","skipCount":1,"studio":"Walt Disney Pictures","summary":"Anna, Elsa, Kristoff, Olaf and Sven leave Arendelle to travel to an ancient, autumn-bound forest of an enchanted land. They set out to find the origin of Elsa's powers in order to save their kingdom.","tagline":"The past is not what it seems.","thumb":"/library/metadata/5858/thumb/1704621922","title":"Frozen II","type":"movie","updatedAt":1704621922,"viewCount":1,"year":2019},{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Byron Howard"},{"tag":"Nathan Greno"}],"Genre":[{"tag":"Comedy"},{"tag":"Animation"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Mandy Moore"},{"tag":"Zachary Levi"},{"tag":"Donna Murphy"}],"Writer":[{"tag":"Jacob Grimm"},{"tag":"Wilhelm Grimm"}],"addedAt":1589412494,"art":"/library/metadata/14944/art/1705739847","audienceRating":8.7,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG","duration":6017237,"guid":"plex://movie/5d77686eeb5d26001f1eb339","key":"/library/metadata/14944","lastViewedAt":1704936047,"librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2010-11-24T00:00:00Z","primaryExtraKey":"/library/metadata/14952","rating":8.9,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"14944","studio":"Walt Disney Animation Studios","summary":"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.","tagline":"They're taking adventure to new lengths.","thumb":"/library/metadata/14944/thumb/1705739847","title":"Tangled","type":"movie","updatedAt":1705739847,"viewCount":1,"year":2010}],"context":"hub.movie.recentlyviewed","hubIdentifier":"movie.recentlyviewed.1","hubKey":"/library/metadata/66485,66098,57249,11449,5858,14944","key":"/library/sections/1/all?sort=lastViewedAt:desc\u0026unwatched=0\u0026viewOffset=0","more":true,"promoted":true,"random":true,"size":6,"style":"shelf","title":"Recently Played Movies","type":"movie"}]` diff --git a/content/types/operations/get_library_hubs_metadata/curl.mdx b/content/types/operations/get_library_hubs_metadata/curl.mdx index 7a7e765..58ab2d1 100644 --- a/content/types/operations/get_library_hubs_metadata/curl.mdx +++ b/content/types/operations/get_library_hubs_metadata/curl.mdx @@ -130,33 +130,21 @@ --- ##### `media` _array (optional)_ -
-**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":6017237,"file":"/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4","has64bitOffsets":false,"id":38247,"key":"/library/parts/38247/1589412494/file.mp4","optimizedForStreaming":true,"size":1545647447,"videoProfile":"high"}],"aspectRatio":1.78,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2051,"container":"mp4","duration":6017237,"has64bitOffsets":false,"height":1080,"id":38247,"optimizedForStreaming":1,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` --- ##### `genre` _array (optional)_ -
-**Example:** `[{"tag":"Animation"}]` --- ##### `country` _array (optional)_ -
-**Example:** `[{"tag":"United States of America"}]` --- ##### `director` _array (optional)_ -
-**Example:** `[{"tag":"Nathan Greno"}]` --- ##### `role` _array (optional)_ -
-**Example:** `[{"tag":"Donna Murphy"}]` --- ##### `writer` _array (optional)_ -
-**Example:** `[{"tag":"Wilhelm Grimm"}]` --- ##### `skipCount` _integer (32-bit) (optional)_ diff --git a/content/types/operations/get_library_items_errors/curl.mdx b/content/types/operations/get_library_items_errors/curl.mdx new file mode 100644 index 0000000..be78074 --- /dev/null +++ b/content/types/operations/get_library_items_errors/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `code` _number (optional)_ +
+**Example:** `1001` + +--- +##### `message` _string (optional)_ +
+**Example:** `User could not be authenticated` + +--- +##### `status` _number (optional)_ +
+**Example:** `401` + + diff --git a/content/types/operations/get_library_items_library_response_body/curl.mdx b/content/types/operations/get_library_items_library_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/get_library_items_library_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/get_library_items_media/curl.mdx b/content/types/operations/get_library_items_media/curl.mdx index 2c2055e..ed9decb 100644 --- a/content/types/operations/get_library_items_media/curl.mdx +++ b/content/types/operations/get_library_items_media/curl.mdx @@ -65,7 +65,5 @@ --- ##### `part` _array (optional)_ -
-**Example:** `[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}]` diff --git a/content/types/operations/get_library_items_media_container/curl.mdx b/content/types/operations/get_library_items_media_container/curl.mdx index 46f0b0b..417089e 100644 --- a/content/types/operations/get_library_items_media_container/curl.mdx +++ b/content/types/operations/get_library_items_media_container/curl.mdx @@ -75,7 +75,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]` diff --git a/content/types/operations/get_library_items_metadata/curl.mdx b/content/types/operations/get_library_items_metadata/curl.mdx index cf48661..b09cc16 100644 --- a/content/types/operations/get_library_items_metadata/curl.mdx +++ b/content/types/operations/get_library_items_metadata/curl.mdx @@ -145,33 +145,21 @@ --- ##### `media` _array (optional)_ -
-**Example:** `[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}]` --- ##### `genre` _array (optional)_ -
-**Example:** `[{"tag":"Adventure"}]` --- ##### `country` _array (optional)_ -
-**Example:** `[{"tag":"United States of America"}]` --- ##### `director` _array (optional)_ -
-**Example:** `[{"tag":"James Cameron"}]` --- ##### `writer` _array (optional)_ -
-**Example:** `[{"tag":"James Cameron"}]` --- ##### `role` _array (optional)_ -
-**Example:** `[{"tag":"Sigourney Weaver"}]` --- ##### `titleSort` _string (optional)_ diff --git a/content/types/operations/get_library_items_request/curl.mdx b/content/types/operations/get_library_items_request/curl.mdx index 7e9ecf1..b6f28d9 100644 --- a/content/types/operations/get_library_items_request/curl.mdx +++ b/content/types/operations/get_library_items_request/curl.mdx @@ -4,6 +4,8 @@ import Labels from "/src/lib/labels"; ##### `sectionId` _integer_ the Id of the library to query +
+**Example:** `1` --- ##### `tag` _enumeration_ diff --git a/content/types/operations/get_library_items_response/curl.mdx b/content/types/operations/get_library_items_response/curl.mdx index bc45ff8..edbb5b0 100644 --- a/content/types/operations/get_library_items_response/curl.mdx +++ b/content/types/operations/get_library_items_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ +##### `twoHundredApplicationJsonObject` _object (optional)_ The contents of the library by section and tag import('/content/types/operations/get_library_items_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/get_library_items_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/get_library_media_container/curl.mdx b/content/types/operations/get_library_media_container/curl.mdx index d40beca..2171fb1 100644 --- a/content/types/operations/get_library_media_container/curl.mdx +++ b/content/types/operations/get_library_media_container/curl.mdx @@ -60,17 +60,11 @@ --- ##### `directory` _array (optional)_ -
-**Example:** `[{"key":"search?type=1","prompt":"Search Movies","search":true,"secondary":true,"title":"Search..."}]` --- ##### `type` _array (optional)_ -
-**Example:** `[{"Field":[{"key":"title","title":"Title","type":"string"},{"key":"studio","title":"Studio","type":"string"},{"key":"userRating","subType":"rating","title":"Rating","type":"integer"},{"key":"contentRating","title":"Content Rating","type":"tag"},{"key":"year","subType":"year","title":"Year","type":"integer"},{"key":"decade","subType":"decade","title":"Decade","type":"integer"},{"key":"originallyAvailableAt","title":"Release Date","type":"date"},{"key":"duration","subType":"duration","title":"Duration","type":"integer"},{"key":"unmatched","title":"Unmatched","type":"boolean"},{"key":"duplicate","title":"Duplicate","type":"boolean"},{"key":"genre","title":"Genre","type":"tag"},{"key":"collection","title":"Collection","type":"tag"},{"key":"director","title":"Director","type":"tag"},{"key":"writer","title":"Writer","type":"tag"},{"key":"producer","title":"Producer","type":"tag"},{"key":"actor","title":"Actor","type":"tag"},{"key":"country","title":"Country","type":"tag"},{"key":"addedAt","title":"Date Added","type":"date"},{"key":"viewCount","title":"Plays","type":"integer"},{"key":"lastViewedAt","title":"Last Played","type":"date"},{"key":"unwatched","title":"Unplayed","type":"boolean"},{"key":"resolution","title":"Resolution","type":"resolution"},{"key":"hdr","subType":"hdr","title":"HDR","type":"boolean"},{"key":"mediaSize","subType":"fileSize","title":"File Size","type":"integer"},{"key":"mediaBitrate","subType":"bitrate","title":"Bitrate","type":"integer"},{"key":"subtitleLanguage","title":"Subtitle Language","type":"subtitleLanguage"},{"key":"audioLanguage","title":"Audio Language","type":"audioLanguage"},{"key":"inProgress","title":"In Progress","type":"boolean"},{"key":"trash","title":"Trash","type":"boolean"},{"key":"editionTitle","title":"Edition","type":"string"},{"key":"label","title":"Label","type":"tag"}],"Filter":[{"filter":"genre","filterType":"string","key":"/library/sections/1/genre","title":"Genre","type":"filter"},{"filter":"year","filterType":"integer","key":"/library/sections/1/year","title":"Year","type":"filter"},{"filter":"decade","filterType":"integer","key":"/library/sections/1/decade","title":"Decade","type":"filter"},{"filter":"contentRating","filterType":"string","key":"/library/sections/1/contentRating","title":"Content Rating","type":"filter"},{"filter":"collection","filterType":"string","key":"/library/sections/1/collection","title":"Collection","type":"filter"},{"filter":"director","filterType":"string","key":"/library/sections/1/director","title":"Director","type":"filter"},{"filter":"actor","filterType":"string","key":"/library/sections/1/actor","title":"Actor","type":"filter"},{"filter":"writer","filterType":"string","key":"/library/sections/1/writer","title":"Writer","type":"filter"},{"filter":"producer","filterType":"string","key":"/library/sections/1/producer","title":"Producer","type":"filter"},{"filter":"country","filterType":"string","key":"/library/sections/1/country","title":"Country","type":"filter"},{"filter":"studio","filterType":"string","key":"/library/sections/1/studio","title":"Studio","type":"filter"},{"filter":"resolution","filterType":"string","key":"/library/sections/1/resolution","title":"Resolution","type":"filter"},{"filter":"hdr","filterType":"boolean","key":"/library/sections/1/hdr","title":"HDR","type":"filter"},{"filter":"unwatched","filterType":"boolean","key":"/library/sections/1/unwatched","title":"Unplayed","type":"filter"},{"filter":"inProgress","filterType":"boolean","key":"/library/sections/1/inProgress","title":"In Progress","type":"filter"},{"filter":"unmatched","filterType":"boolean","key":"/library/sections/1/unmatched","title":"Unmatched","type":"filter"},{"filter":"audioLanguage","filterType":"string","key":"/library/sections/1/audioLanguage","title":"Audio Language","type":"filter"},{"filter":"subtitleLanguage","filterType":"string","key":"/library/sections/1/subtitleLanguage","title":"Subtitle Language","type":"filter"},{"filter":"editionTitle","filterType":"string","key":"/library/sections/1/editionTitle","title":"Edition","type":"filter"},{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}],"Sort":[{"default":"asc","defaultDirection":"asc","descKey":"titleSort:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"titleSort","title":"Title"},{"defaultDirection":"desc","descKey":"originallyAvailableAt:desc","key":"originallyAvailableAt","title":"Release Date"},{"defaultDirection":"desc","descKey":"rating:desc","key":"rating","title":"Critic Rating"},{"defaultDirection":"desc","descKey":"audienceRating:desc","key":"audienceRating","title":"Audience Rating"},{"defaultDirection":"desc","descKey":"duration:desc","key":"duration","title":"Duration"},{"defaultDirection":"desc","descKey":"addedAt:desc","key":"addedAt","title":"Date Added"},{"defaultDirection":"desc","descKey":"lastViewedAt:desc","key":"lastViewedAt","title":"Date Viewed"},{"defaultDirection":"asc","descKey":"mediaHeight:desc","key":"mediaHeight","title":"Resolution"},{"defaultDirection":"desc","descKey":"random:desc","key":"random","title":"Randomly"}],"active":false,"key":"/library/sections/1/all?type=1","title":"Movies","type":"movie"}]` --- ##### `fieldType` _array (optional)_ -
-**Example:** `[{"Operator":[{"key":"=","title":"is"}],"type":"resolution"}]` diff --git a/content/types/operations/get_library_type/curl.mdx b/content/types/operations/get_library_type/curl.mdx index ffcdc50..e27326f 100644 --- a/content/types/operations/get_library_type/curl.mdx +++ b/content/types/operations/get_library_type/curl.mdx @@ -20,17 +20,11 @@ --- ##### `filter` _array (optional)_ -
-**Example:** `[{"filter":"label","filterType":"string","key":"/library/sections/1/label","title":"Labels","type":"filter"}]` --- ##### `sort` _array (optional)_ -
-**Example:** `[{"default":"asc","defaultDirection":"desc","descKey":"random:desc","firstCharacterKey":"/library/sections/1/firstCharacter","key":"random","title":"Randomly"}]` --- ##### `field` _array (optional)_ -
-**Example:** `[{"key":"label","subType":"bitrate","title":"Label","type":"tag"}]` diff --git a/content/types/operations/get_metadata_children_media_container/curl.mdx b/content/types/operations/get_metadata_children_media_container/curl.mdx index 1638cdd..8f7918b 100644 --- a/content/types/operations/get_metadata_children_media_container/curl.mdx +++ b/content/types/operations/get_metadata_children_media_container/curl.mdx @@ -106,11 +106,17 @@ --- ##### `directory` _array (optional)_
-**Example:** `[{"key":"/library/metadata/30072/allLeaves","leafCount":16,"thumb":"/library/metadata/30072/thumb/1705739923","title":"All episodes","viewedLeafCount":16}]` +**Example:** `[ +{ +"leafCount": 16, +"thumb": "/library/metadata/30072/thumb/1705739923", +"viewedLeafCount": 16, +"key": "/library/metadata/30072/allLeaves", +"title": "All episodes" +} +]` --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1702602021,"art":"/library/metadata/30072/art/1705739923","guid":"plex://season/652aea6549508477c34c6000","index":2,"key":"/library/metadata/66488/children","lastRatedAt":1703881224,"lastViewedAt":1705646565,"leafCount":8,"parentGuid":"plex://show/5d9c09190aaccd001f8f42f0","parentIndex":1,"parentKey":"/library/metadata/30072","parentRatingKey":"30072","parentStudio":"Amazon Studios","parentTheme":"/library/metadata/30072/theme/1705739923","parentThumb":"/library/metadata/30072/thumb/1705739923","parentTitle":"Reacher","parentYear":2022,"ratingKey":"66488","skipCount":1,"summary":"Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.","thumb":"/library/metadata/66488/thumb/1703065033","title":"Season 2","type":"season","updatedAt":1703065033,"userRating":9,"viewCount":11,"viewedLeafCount":8}]` diff --git a/content/types/operations/get_metadata_media/curl.mdx b/content/types/operations/get_metadata_media/curl.mdx index b5c11b4..bf7b438 100644 --- a/content/types/operations/get_metadata_media/curl.mdx +++ b/content/types/operations/get_metadata_media/curl.mdx @@ -80,7 +80,5 @@ --- ##### `part` _array (optional)_ -
-**Example:** `[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` diff --git a/content/types/operations/get_metadata_media_container/curl.mdx b/content/types/operations/get_metadata_media_container/curl.mdx index 1e78cd0..6b137a4 100644 --- a/content/types/operations/get_metadata_media_container/curl.mdx +++ b/content/types/operations/get_metadata_media_container/curl.mdx @@ -40,7 +40,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"Country":[{"filter":"country=116","id":116,"tag":"United States of America"}],"Director":[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"Genre":[{"filter":"genre=5","id":5,"tag":"Science Fiction"}],"Guid":[{"id":"imdb://tt0379786"}],"Media":[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Producer":[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}],"Rating":[{"image":"imdb://image.rating","type":"audience","value":7.8}],"Role":[{"filter":"actor=8","id":8,"role":"Malcolm \"Mal\" Reynolds","tag":"Nathan Fillion","tagKey":"5d7768286f4521001ea9945c","thumb":"https://metadata-static.plex.tv/4/people/4a2890ca346eb832500b1ed0add89d5e.jpg"}],"Writer":[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141417,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","type":"movie","updatedAt":1705637165,"year":2005}]` diff --git a/content/types/operations/get_metadata_metadata/curl.mdx b/content/types/operations/get_metadata_metadata/curl.mdx index 184500b..af0682f 100644 --- a/content/types/operations/get_metadata_metadata/curl.mdx +++ b/content/types/operations/get_metadata_metadata/curl.mdx @@ -120,47 +120,29 @@ --- ##### `media` _array (optional)_ -
-**Example:** `[{"Part":[{"Stream":[{"bitDepth":8,"bitrate":2160,"chromaLocation":"left","chromaSubsampling":14520,"codec":"h264","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"1080p (H.264)","extendedDisplayTitle":"1080p (H.264)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":30,"index":1,"level":40,"profile":"high","refFrames":4,"scanType":"progressive","streamIdentifier":"2","streamType":1,"width":1920},{"bitrate":128,"channels":2,"codec":"aac","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","profile":"lc","samplingRate":44100,"selected":true,"streamIdentifier":"1","streamType":2}],"audioProfile":"lc","container":"mp4","duration":141417,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2278,"container":"mp4","duration":141417,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` --- ##### `genre` _array (optional)_ -
-**Example:** `[{"filter":"genre=184","id":184,"tag":"Thriller"}]` --- ##### `country` _array (optional)_ -
-**Example:** `[{"filter":"country=116","id":116,"tag":"United States of America"}]` --- ##### `guids` _array (optional)_ -
-**Example:** `[{"id":"tvdb://2337"}]` --- ##### `ratings` _array (optional)_ -
-**Example:** `[{"image":"themoviedb://image.rating","type":"audience","value":7.4}]` --- ##### `director` _array (optional)_ -
-**Example:** `[{"filter":"director=130","id":130,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` --- ##### `writer` _array (optional)_ -
-**Example:** `[{"filter":"writer=132","id":132,"tag":"Joss Whedon","tagKey":"5d776828880197001ec90e8f","thumb":"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"}]` --- ##### `role` _array (optional)_ -
-**Example:** `[{"filter":"actor=220","id":220,"role":"Bar Guy (uncredited)","tag":"Dennis Keiffer","tagKey":"5d77683554f42c001f8c4708","thumb":"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"}]` --- ##### `producer` _array (optional)_ -
-**Example:** `[{"filter":"producer=221","id":221,"tag":"Barry Mendel","tagKey":"5d776826961905001eb90e2b","thumb":"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"}]` diff --git a/content/types/operations/get_metadata_part/curl.mdx b/content/types/operations/get_metadata_part/curl.mdx index 6803980..41b7057 100644 --- a/content/types/operations/get_metadata_part/curl.mdx +++ b/content/types/operations/get_metadata_part/curl.mdx @@ -50,7 +50,5 @@ --- ##### `stream` _array (optional)_ -
-**Example:** `[{"bitDepth":8,"bitrate":128,"channels":2,"chromaLocation":"left","chromaSubsampling":14520,"codec":"aac","codedHeight":816,"codedWidth":1920,"colorPrimaries":"bt709","colorRange":"tv","colorSpace":"bt709","colorTrc":"bt709","default":true,"displayTitle":"English (AAC Stereo)","extendedDisplayTitle":"English (AAC Stereo)","frameRate":24,"hasScalingMatrix":false,"height":814,"id":29,"index":0,"language":"English","languageCode":"eng","languageTag":"en","level":40,"profile":"lc","refFrames":4,"samplingRate":44100,"scanType":"progressive","selected":true,"streamIdentifier":"1","streamType":2,"width":1920}]` diff --git a/content/types/operations/get_pin_request/curl.mdx b/content/types/operations/get_pin_request/curl.mdx index 92e5e88..6c9ffd7 100644 --- a/content/types/operations/get_pin_request/curl.mdx +++ b/content/types/operations/get_pin_request/curl.mdx @@ -1,15 +1,17 @@ {/* Autogenerated DO NOT EDIT */} -##### `xPlexClientIdentifier` _string_ -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- ##### `strong` _boolean (optional)_ Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non\-Strong codes are used for `Plex.tv/link` +--- +##### `xPlexClientIdentifier` _string (optional)_ +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + diff --git a/content/types/operations/get_playlist_contents_media/curl.mdx b/content/types/operations/get_playlist_contents_media/curl.mdx index a4e3b42..7430f9d 100644 --- a/content/types/operations/get_playlist_contents_media/curl.mdx +++ b/content/types/operations/get_playlist_contents_media/curl.mdx @@ -80,7 +80,5 @@ --- ##### `part` _array (optional)_ -
-**Example:** `[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}]` diff --git a/content/types/operations/get_playlist_contents_media_container/curl.mdx b/content/types/operations/get_playlist_contents_media_container/curl.mdx index 3f17f3a..0df0633 100644 --- a/content/types/operations/get_playlist_contents_media_container/curl.mdx +++ b/content/types/operations/get_playlist_contents_media_container/curl.mdx @@ -40,7 +40,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"Joss Whedon"}],"Genre":[{"tag":"Science Fiction"}],"Media":[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}],"Role":[{"tag":"Nathan Fillion"}],"Writer":[{"tag":"Joss Whedon"}],"addedAt":1705637164,"art":"/library/metadata/17/art/1705637165","audienceRating":9.1,"audienceRatingImage":"rottentomatoes://image.rating.upright","contentRating":"PG-13","duration":141416,"guid":"plex://movie/5d77683f6f4521001ea9dc53","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","key":"/library/metadata/17","librarySectionID":1,"librarySectionKey":"/library/sections/1","librarySectionTitle":"Movies","originallyAvailableAt":"2005-09-29T00:00:00Z","rating":8.2,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"17","studio":"Universal Pictures","summary":"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.","tagline":"They aim to misbehave.","thumb":"/library/metadata/17/thumb/1705637165","title":"Serenity","titleSort":"Amazing Spider-Man 2","type":"movie","updatedAt":1705637165,"year":2005}]` diff --git a/content/types/operations/get_playlist_contents_metadata/curl.mdx b/content/types/operations/get_playlist_contents_metadata/curl.mdx index 537b86d..66b9167 100644 --- a/content/types/operations/get_playlist_contents_metadata/curl.mdx +++ b/content/types/operations/get_playlist_contents_metadata/curl.mdx @@ -130,32 +130,20 @@ --- ##### `media` _array (optional)_ -
-**Example:** `[{"Part":[{"audioProfile":"lc","container":"mp4","duration":141416,"file":"/movies/Serenity (2005)/Serenity (2005).mp4","has64bitOffsets":false,"id":15,"key":"/library/parts/15/1705637151/file.mp4","optimizedForStreaming":false,"size":40271948,"videoProfile":"high"}],"aspectRatio":2.35,"audioChannels":2,"audioCodec":"aac","audioProfile":"lc","bitrate":2273,"container":"mp4","duration":141416,"has64bitOffsets":false,"height":814,"id":15,"optimizedForStreaming":0,"videoCodec":"h264","videoFrameRate":"24p","videoProfile":"high","videoResolution":"1080","width":1920}]` --- ##### `genre` _array (optional)_ -
-**Example:** `[{"tag":"Action"}]` --- ##### `country` _array (optional)_ -
-**Example:** `[{"tag":"United States of America"}]` --- ##### `director` _array (optional)_ -
-**Example:** `[{"tag":"Joss Whedon"}]` --- ##### `writer` _array (optional)_ -
-**Example:** `[{"tag":"Joss Whedon"}]` --- ##### `role` _array (optional)_ -
-**Example:** `[{"tag":"Gina Torres"}]` diff --git a/content/types/operations/get_playlist_media_container/curl.mdx b/content/types/operations/get_playlist_media_container/curl.mdx index 9b14c2c..012d4d8 100644 --- a/content/types/operations/get_playlist_media_container/curl.mdx +++ b/content/types/operations/get_playlist_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1705716493,"composite":"/playlists/95/composite/1705717387","content":"library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1","duration":282000,"guid":"com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91","icon":"playlist://image.smart","key":"/playlists/95/items","leafCount":2,"playlistType":"video","ratingKey":"95","smart":true,"summary":"","title":"Smart Movie Playlist","type":"playlist","updatedAt":1705717387}]` diff --git a/content/types/operations/get_playlists_media_container/curl.mdx b/content/types/operations/get_playlists_media_container/curl.mdx index 76b326c..b89e234 100644 --- a/content/types/operations/get_playlists_media_container/curl.mdx +++ b/content/types/operations/get_playlists_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1705716298,"composite":"/playlists/92/composite/1705716440","duration":7328000,"guid":"com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903","icon":"playlist://image.smart","key":"/playlists/92/items","lastViewedAt":1705716298,"leafCount":32,"playlistType":"video","ratingKey":"92","smart":false,"summary":"A Great Playlist","title":"Static Playlist","type":"playlist","updatedAt":1705716440,"viewCount":1}]` diff --git a/content/types/operations/get_server_preferences_media_container/curl.mdx b/content/types/operations/get_server_preferences_media_container/curl.mdx index 0084d63..8a2db32 100644 --- a/content/types/operations/get_server_preferences_media_container/curl.mdx +++ b/content/types/operations/get_server_preferences_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `setting` _array (optional)_ -
-**Example:** `[{"advanced":false,"default":false,"enumValues":"1:admin only|2:everyone","group":"","hidden":true,"id":"EnableDatabaseTrace","label":"","summary":"","type":"bool","value":false}]` diff --git a/content/types/operations/get_session_history_media_container/curl.mdx b/content/types/operations/get_session_history_media_container/curl.mdx index 5c8a341..d4c4a8f 100644 --- a/content/types/operations/get_session_history_media_container/curl.mdx +++ b/content/types/operations/get_session_history_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"accountID":1,"deviceID":5,"grandparentArt":"/library/metadata/32132/art/1703933346","grandparentKey":"/library/metadata/32132","grandparentThumb":"/library/metadata/32132/thumb/1703933346","grandparentTitle":"Taskmaster","historyKey":"/status/sessions/history/1","index":1,"key":"/library/metadata/32171","librarySectionID":"2","originallyAvailableAt":"2022-04-14T00:00:00Z","parentIndex":13,"parentKey":"/library/metadata/32170","parentThumb":"/library/metadata/32170/thumb/1654134301","ratingKey":"32171","thumb":"/library/metadata/32171/thumb/-1","title":"The Noise That Blue Makes","type":"episode","viewedAt":1654139223}]` diff --git a/content/types/operations/get_sessions_media/curl.mdx b/content/types/operations/get_sessions_media/curl.mdx index 75ffd93..cd76027 100644 --- a/content/types/operations/get_sessions_media/curl.mdx +++ b/content/types/operations/get_sessions_media/curl.mdx @@ -35,7 +35,5 @@ --- ##### `part` _array (optional)_ -
-**Example:** `[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}]` diff --git a/content/types/operations/get_sessions_media_container/curl.mdx b/content/types/operations/get_sessions_media_container/curl.mdx index 122272c..012d4d8 100644 --- a/content/types/operations/get_sessions_media_container/curl.mdx +++ b/content/types/operations/get_sessions_media_container/curl.mdx @@ -5,7 +5,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"Media":[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}],"Player":{"address":"10.10.10.171","local":true,"machineIdentifier":"3tsdzir85m2onc3qyr255aq1","model":"standalone","platform":"windows","platformVersion":"10.0.22621","product":"Plex for Windows","profile":"Plex Desktop","relayed":false,"remotePublicAddress":"68.248.140.20","secure":true,"state":"playing","title":"DESKTOP-BL80MTD","userID":1,"version":"1.85.0.4071-21128b56"},"Session":{"bandwidth":1050,"id":"93h7e00ncblxncqw9lkfaoxi","location":"lan"},"User":{"id":"1","thumb":"https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661","title":"Blindkitty38"},"addedAt":1705543312,"art":"/library/metadata/39904/art/1705310687","duration":186240,"grandparentArt":"/library/metadata/39904/art/1705310687","grandparentGuid":"plex://artist/5d07bbfd403c6402904a6480","grandparentKey":"/library/metadata/39904","grandparentRatingKey":"39904","grandparentThumb":"/library/metadata/39904/thumb/1705310687","grandparentTitle":"Green Day","guid":"plex://track/6535834f71f22f36f71a8e8f","index":1,"key":"/library/metadata/67085","librarySectionID":"3","librarySectionKey":"/library/sections/3","librarySectionTitle":"Music","musicAnalysisVersion":"1","parentGuid":"plex://album/65394d6d472b8ab03ef47f12","parentIndex":1,"parentKey":"/library/metadata/67084","parentRatingKey":"67084","parentStudio":"Reprise Records","parentThumb":"/library/metadata/67084/thumb/1705543314","parentTitle":"Saviors","parentYear":2024,"ratingCount":45885,"ratingKey":"67085","sessionKey":"203","thumb":"/library/metadata/67084/thumb/1705543314","title":"The American Dream Is Killing Me","titleSort":"American Dream Is Killing Me","type":"track","updatedAt":1705543314,"viewOffset":1000}]` diff --git a/content/types/operations/get_sessions_metadata/curl.mdx b/content/types/operations/get_sessions_metadata/curl.mdx index 1971047..73b7424 100644 --- a/content/types/operations/get_sessions_metadata/curl.mdx +++ b/content/types/operations/get_sessions_metadata/curl.mdx @@ -168,8 +168,6 @@ import Labels from "/src/lib/labels"; --- ##### `media` _array (optional)_ -
-**Example:** `[{"Part":[{"Stream":[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}],"container":"flac","decision":"directplay","duration":186240,"file":"/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac","hasThumbnail":"1","id":"130625","key":"/library/parts/130625/1705543268/file.flac","selected":true,"size":23644000}],"audioChannels":2,"audioCodec":"flac","bitrate":1014,"container":"flac","duration":186240,"id":"130355","selected":true}]` --- ##### `user` _object (optional)_ diff --git a/content/types/operations/get_sessions_part/curl.mdx b/content/types/operations/get_sessions_part/curl.mdx index 2a6fbc8..5ed2a02 100644 --- a/content/types/operations/get_sessions_part/curl.mdx +++ b/content/types/operations/get_sessions_part/curl.mdx @@ -45,7 +45,5 @@ --- ##### `stream` _array (optional)_ -
-**Example:** `[{"albumGain":"-12.94","albumPeak":"1.000000","albumRange":"4.751014","audioChannelLayout":"stereo","bitDepth":16,"bitrate":1014,"channels":2,"codec":"flac","displayTitle":"FLAC (Stereo)","extendedDisplayTitle":"FLAC (Stereo)","gain":"-12.94","id":"352487","index":0,"location":"direct","loudness":"-5.94","lra":"1.74","peak":"1.000000","samplingRate":44100,"selected":true,"streamType":2}]` diff --git a/content/types/operations/get_statistics_media_container/curl.mdx b/content/types/operations/get_statistics_media_container/curl.mdx index 824fac8..bbbe129 100644 --- a/content/types/operations/get_statistics_media_container/curl.mdx +++ b/content/types/operations/get_statistics_media_container/curl.mdx @@ -5,17 +5,11 @@ --- ##### `device` _array (optional)_ -
-**Example:** `[{"clientIdentifier":"793095d235660625108ef785cc7646e9","createdAt":1706470556,"id":208,"name":"Roku Express","platform":"Roku"}]` --- ##### `account` _array (optional)_ -
-**Example:** `[{"autoSelectAudio":true,"defaultAudioLanguage":"en","defaultSubtitleLanguage":"en","id":238960586,"key":"/accounts/238960586","name":"Diane","subtitleMode":1,"thumb":"https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"}]` --- ##### `statisticsMedia` _array (optional)_ -
-**Example:** `[{"accountID":1,"at":1707141600,"count":1,"deviceID":13,"duration":1555,"metadataType":4,"timespan":4}]` diff --git a/content/types/operations/get_statistics_request/curl.mdx b/content/types/operations/get_statistics_request/curl.mdx index 545365e..fc67e6b 100644 --- a/content/types/operations/get_statistics_request/curl.mdx +++ b/content/types/operations/get_statistics_request/curl.mdx @@ -3,5 +3,7 @@ The timespan to retrieve statistics for the exact meaning of this parameter is not known +
+**Example:** `4` diff --git a/content/types/operations/get_timeline_request/curl.mdx b/content/types/operations/get_timeline_request/curl.mdx index 02c36b4..29a9e06 100644 --- a/content/types/operations/get_timeline_request/curl.mdx +++ b/content/types/operations/get_timeline_request/curl.mdx @@ -4,14 +4,20 @@ import Labels from "/src/lib/labels"; ##### `ratingKey` _number_ The rating key of the media item +
+**Example:** `23409` --- ##### `key` _string_ The key of the media item to get the timeline for +
+**Example:** `/library/metadata/23409` --- ##### `state` _enumeration_ The state of the media item +
+**Example:** `playing` import('/content/types/operations/state/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> @@ -19,29 +25,43 @@ The state of the media item --- ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `time` _number_ The time of the media item +
+**Example:** `2000` --- ##### `duration` _number_ The duration of the media item +
+**Example:** `10000` --- ##### `context` _string_ The context of the media item +
+**Example:** `home:hub.continueWatching` --- ##### `playQueueItemID` _number_ The play queue item ID of the media item +
+**Example:** `1` --- ##### `playBackTime` _number_ The playback time of the media item +
+**Example:** `2000` --- ##### `row` _number_ The row of the media item +
+**Example:** `1` diff --git a/content/types/operations/get_token_request/curl.mdx b/content/types/operations/get_token_request/curl.mdx index 403bb25..9976e89 100644 --- a/content/types/operations/get_token_request/curl.mdx +++ b/content/types/operations/get_token_request/curl.mdx @@ -3,10 +3,12 @@ The PinID to retrieve an access token for --- -##### `xPlexClientIdentifier` _string_ +##### `xPlexClientIdentifier` _string (optional)_ The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) +
+**Example:** `Postman` diff --git a/content/types/operations/get_transcode_sessions_media_container/curl.mdx b/content/types/operations/get_transcode_sessions_media_container/curl.mdx index 00d0db7..378db30 100644 --- a/content/types/operations/get_transcode_sessions_media_container/curl.mdx +++ b/content/types/operations/get_transcode_sessions_media_container/curl.mdx @@ -6,6 +6,33 @@ --- ##### `transcodeSession` _array (optional)_
-**Example:** `[{"audioChannels":1,"audioCodec":"opus","audioDecision":"transcode","complete":false,"container":"mkv","context":"streaming","duration":1445695,"error":false,"key":"vv3i2q2lax92qlzul1hbd4bx","maxOffsetAvailable":29.53,"minOffsetAvailable":3.003000020980835,"progress":1.7999999523162842,"protocol":"http","remaining":53,"size":-22,"sourceAudioCodec":"aac","sourceVideoCodec":"h264","speed":25.100000381469727,"subtitleDecision":"burn","throttled":false,"timeStamp":1705895805.4919229,"transcodeHwRequested":true,"videoCodec":"h264","videoDecision":"transcode"}]` +**Example:** `[ +{ +"key": "vv3i2q2lax92qlzul1hbd4bx", +"throttled": false, +"complete": false, +"progress": 1.7999999523162842, +"size": -22, +"speed": 25.100000381469727, +"error": false, +"duration": 1445695, +"remaining": 53, +"context": "streaming", +"sourceVideoCodec": "h264", +"sourceAudioCodec": "aac", +"videoDecision": "transcode", +"audioDecision": "transcode", +"subtitleDecision": "burn", +"protocol": "http", +"container": "mkv", +"videoCodec": "h264", +"audioCodec": "opus", +"audioChannels": 1, +"transcodeHwRequested": true, +"timeStamp": 1705895805.4919229, +"maxOffsetAvailable": 29.53, +"minOffsetAvailable": 3.003000020980835 +} +]` diff --git a/content/types/operations/get_update_status_media_container/curl.mdx b/content/types/operations/get_update_status_media_container/curl.mdx index 3ec1fbd..837dc2e 100644 --- a/content/types/operations/get_update_status_media_container/curl.mdx +++ b/content/types/operations/get_update_status_media_container/curl.mdx @@ -26,6 +26,15 @@ --- ##### `release` _array (optional)_
-**Example:** `[{"added":"(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0","downloadURL":"https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx","fixed":"(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)","key":"https://plex.tv/updater/releases/5136","state":"notify","version":"1.40.0.7775-456fbaf97"}]` +**Example:** `[ +{ +"key": "https://plex.tv/updater/releases/5136", +"version": "1.40.0.7775-456fbaf97", +"added": "(PLEASE NOTE) This version makes changes to the database which will make it compatible only with server versions 1.31.2 or higher (released March 14). You will not be able to use your database on Plex Media Server versions lower than this after this update. Please also be patient when updating to this version if you have a very large database and allow the upgrade process to finish.\n(Collections) Items added to a collection from the item context menu will now lock the collection field on the items (#12793)\n(Music) Store track genres and add filtering options (#14653)\n(Music) Support ID3v2.4 null-separated tags for genres and release type (#14653)\n(View History) No longer create a view history entry for items marked as played (#10888)\n(Web) Updated to 4.118.0", +"fixed": "(Agents) Changing a 'Other Videos' type library to the modern movie agent would fail (#14483)\n(Agents) It is possible that agents are not initialised during startup on rare occasions (#14654)\n(Agents) Remove the legacy OpenSubtitles agent which is no longer supported upstream (#14667)\n(Collection) Server could become unresponsive when collection membership changes (#14612)\n(DVR) Previously watched recordings could be deleted without being watched again (#13779)\n(Libraries) When performing fix match on items from certain music libraries the language would default to Arabic (#14501)\n(Library) The Content Rating not equal to None filter does not work (#14620)\n(Search) Album search results could contain all the album's tracks too (#14486)\n(Subtitles) In some circumstances, sidecar subtitles can show up for media when they're no longer available (#14674)\n(Transcoder) HW encoding would fail on devices with no rate control (#14222)\n(Transcoder) Software transcoding on Ubuntu could cause unexpected behavior (#14605)", +"downloadURL": "https://plex.tv/downloads/latest/5?channel=8\u0026build=linux-x86_64\u0026distro=redhat\u0026X-Plex-Token=xxxxxxxxxxxxxxxxxxxx", +"state": "notify" +} +]` diff --git a/content/types/operations/hub/curl.mdx b/content/types/operations/hub/curl.mdx index c2b4f1c..b3167aa 100644 --- a/content/types/operations/hub/curl.mdx +++ b/content/types/operations/hub/curl.mdx @@ -50,7 +50,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1668779618,"composite":"/playlists/57070/composite/1668787730","duration":16873000,"guid":"com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c","icon":"playlist://image.smart","key":"/playlists/57070/items","lastViewedAt":1668787732,"leafCount":3,"playlistType":"video","ratingKey":"57070","smart":false,"summary":"","title":"November Movie Day","titleSort":"Tracks","type":"playlist","updatedAt":1668787730,"viewCount":2}]` diff --git a/content/types/operations/search_library_errors/curl.mdx b/content/types/operations/search_library_errors/curl.mdx new file mode 100644 index 0000000..be78074 --- /dev/null +++ b/content/types/operations/search_library_errors/curl.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +##### `code` _number (optional)_ +
+**Example:** `1001` + +--- +##### `message` _string (optional)_ +
+**Example:** `User could not be authenticated` + +--- +##### `status` _number (optional)_ +
+**Example:** `401` + + diff --git a/content/types/operations/search_library_library_response_body/curl.mdx b/content/types/operations/search_library_library_response_body/curl.mdx new file mode 100644 index 0000000..91839c7 --- /dev/null +++ b/content/types/operations/search_library_library_response_body/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} +##### `errors` _array (optional)_ + + diff --git a/content/types/operations/search_library_media_container/curl.mdx b/content/types/operations/search_library_media_container/curl.mdx index 4f41a76..6a057c9 100644 --- a/content/types/operations/search_library_media_container/curl.mdx +++ b/content/types/operations/search_library_media_container/curl.mdx @@ -60,7 +60,5 @@ --- ##### `metadata` _array (optional)_ -
-**Example:** `[{"addedAt":1705636916,"art":"/library/metadata/1/art/1705636920","guid":"plex://season/602e67e766dfdb002c0a1b5b","index":1,"key":"/library/metadata/2/children","parentGuid":"plex://show/5d9c086c7d06d9001ffd27aa","parentIndex":1,"parentKey":"/library/metadata/1","parentRatingKey":"1","parentStudio":"Mutant Enemy Productions","parentTheme":"/library/metadata/1/theme/1705636920","parentThumb":"/library/metadata/1/thumb/1705636920","parentTitle":"Firefly","parentYear":2002,"ratingKey":"2","summary":"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.","thumb":"/library/metadata/2/thumb/1705636920","title":"Season 1","type":"season","updatedAt":1705636920}]` diff --git a/content/types/operations/search_library_response/curl.mdx b/content/types/operations/search_library_response/curl.mdx index b266ef7..c470baf 100644 --- a/content/types/operations/search_library_response/curl.mdx +++ b/content/types/operations/search_library_response/curl.mdx @@ -14,10 +14,17 @@ HTTP response status code for this operation Raw HTTP response; suitable for custom response parsing --- -##### `object` _object (optional)_ +##### `twoHundredApplicationJsonObject` _object (optional)_ The contents of the library by section and type import('/content/types/operations/search_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> +--- +##### `fourHundredAndOneApplicationJsonObject` _object (optional)_ +Unauthorized \- Returned if the X\-Plex\-Token is missing from the header or query. + + import('/content/types/operations/search_library_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + diff --git a/content/types/operations/start_universal_transcode_request/curl.mdx b/content/types/operations/start_universal_transcode_request/curl.mdx index 77cdb93..451bc88 100644 --- a/content/types/operations/start_universal_transcode_request/curl.mdx +++ b/content/types/operations/start_universal_transcode_request/curl.mdx @@ -1,65 +1,97 @@ {/* Autogenerated DO NOT EDIT */} ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `path` _string_ The path to the media item to transcode +
+**Example:** `/library/metadata/23409` --- ##### `mediaIndex` _number_ The index of the media item to transcode +
+**Example:** `0` --- ##### `partIndex` _number_ The index of the part to transcode +
+**Example:** `0` --- ##### `protocol` _string_ The protocol to use for the transcode session +
+**Example:** `hls` --- ##### `fastSeek` _number (optional)_ Whether to use fast seek or not +
+**Example:** `0` --- ##### `directPlay` _number (optional)_ Whether to use direct play or not +
+**Example:** `0` --- ##### `directStream` _number (optional)_ Whether to use direct stream or not +
+**Example:** `0` --- ##### `subtitleSize` _number (optional)_ The size of the subtitles +
+**Example:** `100` --- ##### `subtites` _string (optional)_ The subtitles +
+**Example:** `burn` --- ##### `audioBoost` _number (optional)_ The audio boost +
+**Example:** `100` --- ##### `location` _string (optional)_ The location of the transcode session +
+**Example:** `lan` --- ##### `mediaBufferSize` _number (optional)_ The size of the media buffer +
+**Example:** `102400` --- ##### `session` _string (optional)_ The session ID +
+**Example:** `zvcage8b7rkioqcm8f4uns4c` --- ##### `addDebugOverlay` _number (optional)_ Whether to add a debug overlay or not +
+**Example:** `0` --- ##### `autoAdjustQuality` _number (optional)_ Whether to auto adjust quality or not +
+**Example:** `0` diff --git a/content/types/operations/update_play_progress_request/curl.mdx b/content/types/operations/update_play_progress_request/curl.mdx index ccfcbf9..c691b31 100644 --- a/content/types/operations/update_play_progress_request/curl.mdx +++ b/content/types/operations/update_play_progress_request/curl.mdx @@ -5,9 +5,13 @@ the media key --- ##### `time` _number_ The time, in milliseconds, used to set the media playback progress. +
+**Example:** `90000` --- ##### `state` _string_ The playback state of the media item. +
+**Example:** `played` diff --git a/gen.yaml b/gen.yaml index 9440e46..022329c 100644 --- a/gen.yaml +++ b/gen.yaml @@ -8,8 +8,10 @@ generation: nameResolutionDec2023: false parameterOrderingFeb2024: false requestResponseComponentNamesFeb2024: false + auth: + oAuth2ClientCredentialsEnabled: false docs: - version: 0.4.0 + version: 0.5.0 defaultLanguage: go docsLanguages: - go @@ -28,6 +30,7 @@ docs: go: version: 0.0.2 additionalDependencies: {} + allowUnknownFieldsInWeakUnions: false clientServerStatusCodesAsErrors: true flattenGlobalSecurity: true imports: @@ -40,10 +43,16 @@ go: webhooks: models/webhooks inputModelSuffix: input maxMethodParams: 4 + methodArguments: require-security-and-request outputModelSuffix: output packageName: github.com/LukeHagar/plexgo + responseFormat: envelope-http python: version: 0.0.1 + additionalDependencies: + dependencies: {} + extraDependencies: + dev: {} author: LukeHagar clientServerStatusCodesAsErrors: true description: Python Client SDK Generated by Speakeasy @@ -58,16 +67,21 @@ python: webhooks: models/webhooks inputModelSuffix: input maxMethodParams: 4 + methodArguments: require-security-and-request outputModelSuffix: output packageName: plexpy + projectUrls: {} + responseFormat: envelope-http typescript: version: 0.3.3 additionalDependencies: dependencies: {} devDependencies: {} peerDependencies: {} + additionalPackageJSON: {} author: LukeHagar clientServerStatusCodesAsErrors: true + enumFormat: enum flattenGlobalSecurity: true imports: option: openapi @@ -79,6 +93,7 @@ typescript: webhooks: models/webhooks inputModelSuffix: input maxMethodParams: 4 + methodArguments: require-security-and-request outputModelSuffix: output packageName: '@lukehagar/plexjs' responseFormat: envelope-http diff --git a/package.json b/package.json index f3dd34e..0221782 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sdk-docs", - "version": "0.4.0", + "version": "0.5.0", "description": "Nextra docs template", "private": true, "scripts": { diff --git a/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx index 6760e88..8ae9996 100644 --- a/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx @@ -1,4 +1,6 @@ {/* Autogenerated DO NOT EDIT */} ##### `activityUUID` _string_ The UUID of the activity to cancel. +
+**Example:** `25b71ed5-0f9d-461c-baa7-d404e9e10d3e` diff --git a/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx index a184747..789d656 100644 --- a/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/activities/ \ +curl http://10.10.10.47:32400/activities/25b71ed5-0f9d-461c-baa7-d404e9e10d3e \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/authentication/authentication.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/authentication.mdx new file mode 100644 index 0000000..42e7802 --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/authentication/authentication.mdx @@ -0,0 +1,6 @@ +import Authentication from './authentication_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/curl/resources/authentication/authentication_content.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/authentication_content.mdx new file mode 100644 index 0000000..43dba8e --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/authentication/authentication_content.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/curl/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/curl/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_authentication.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_header.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_parameters.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_response.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx similarity index 76% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx index 52e3e0d..a602e36 100644 --- a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/security/resources?source=server%3A%2F%2Fclient-identifier \ +curl http://10.10.10.47:32400/security/resources?source=provider%3A%2F%2Fprovider-identifier \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx similarity index 95% rename from src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information_content.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx index 4ec38f5..15884bf 100644 --- a/src/.gen/pages/01-reference/curl/resources/security/get_source_connection_information/get_source_connection_information_content.mdx +++ b/src/.gen/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Security* +###### *Authentication* } diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_authentication.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_header.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_response.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_usage.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 100% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token_content.mdx similarity index 95% rename from src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token_content.mdx rename to src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token_content.mdx index 4ec38f5..15884bf 100644 --- a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/get_transient_token_content.mdx +++ b/src/.gen/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token_content.mdx @@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx'; import SDKHeader from './_header.mdx'; import OperationHeader from '/src/components/OperationHeader'; -###### *Security* +###### *Authentication* } diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx index 82d2f40..f44dda6 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs?count=8121.69 \ +curl http://10.10.10.47:32400/hubs?count=7151.9 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -13,7 +13,41 @@ curl http://10.10.10.47:32400/hubs?count=8121.69 \ "size": 8, "allowSync": true, "identifier": "com.plexapp.plugins.library", - "Hub": [] + "Hub": [ + { + "hubKey": "/library/metadata/50768,65523,58188,57341,57302,57070", + "key": "/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio", + "title": "Recent Playlists", + "type": "playlist", + "hubIdentifier": "home.playlists", + "context": "hub.home.playlists", + "size": 6, + "more": true, + "style": "shelf", + "promoted": true, + "Metadata": [ + { + "ratingKey": "57070", + "key": "/playlists/57070/items", + "guid": "com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c", + "type": "playlist", + "title": "November Movie Day", + "titleSort": "Tracks", + "summary": "", + "smart": false, + "playlistType": "video", + "composite": "/playlists/57070/composite/1668787730", + "icon": "playlist://image.smart", + "viewCount": 2, + "lastViewedAt": 1668787732, + "duration": 16873000, + "leafCount": 3, + "addedAt": 1668779618, + "updatedAt": 1668787730 + } + ] + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx index 425d666..5ef05b4 100644 --- a/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \ +curl http://10.10.10.47:32400/hubs/sections/8442.66?count=6027.63 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -16,7 +16,112 @@ curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \ "librarySectionID": 1, "librarySectionTitle": "Movies", "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", - "Hub": [] + "Hub": [ + { + "key": "/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0", + "title": "Recently Played Movies", + "type": "movie", + "hubIdentifier": "movie.recentlyviewed.1", + "context": "hub.movie.recentlyviewed", + "size": 6, + "more": true, + "style": "shelf", + "hubKey": "/library/metadata/66485,66098,57249,11449,5858,14944", + "Metadata": [ + { + "ratingKey": "14944", + "key": "/library/metadata/14944", + "guid": "plex://movie/5d77686eeb5d26001f1eb339", + "studio": "Walt Disney Animation Studios", + "type": "movie", + "title": "Tangled", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG", + "summary": "The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.", + "rating": 8.9, + "audienceRating": 8.7, + "viewCount": 1, + "lastViewedAt": 1704936047, + "year": 2010, + "tagline": "They're taking adventure to new lengths.", + "thumb": "/library/metadata/14944/thumb/1705739847", + "art": "/library/metadata/14944/art/1705739847", + "duration": 6017237, + "originallyAvailableAt": "2010-11-24T00:00:00Z", + "addedAt": 1589412494, + "updatedAt": 1705739847, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "primaryExtraKey": "/library/metadata/14952", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 38247, + "duration": 6017237, + "bitrate": 2051, + "width": 1920, + "height": 1080, + "aspectRatio": 1.78, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 1, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 38247, + "key": "/library/parts/38247/1589412494/file.mp4", + "duration": 6017237, + "file": "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4", + "size": 1545647447, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": true, + "videoProfile": "high" + } + ] + } + ], + "Genre": [ + { + "tag": "Animation" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "Nathan Greno" + } + ], + "Role": [ + { + "tag": "Donna Murphy" + } + ], + "Writer": [ + { + "tag": "Wilhelm Grimm" + } + ], + "skipCount": 1, + "chapterSource": "media" + } + ], + "promoted": true, + "random": true + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx index c890260..cd99312 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/hashes?type=8360.79&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \ +curl http://10.10.10.47:32400/library/hashes?type=4236.55&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx index ffa713f..2214097 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx @@ -13,7 +13,36 @@ curl http://10.10.10.47:32400/library/sections \ "size": 5, "allowSync": false, "title1": "Plex Library", - "Directory": [] + "Directory": [ + { + "allowSync": true, + "art": "/:/resources/movie-fanart.jpg", + "composite": "/library/sections/1/composite/1705615584", + "filters": true, + "refreshing": false, + "thumb": "/:/resources/movie.png", + "key": "1", + "type": "movie", + "title": "Movies", + "agent": "tv.plex.agents.movie", + "scanner": "Plex Movie", + "language": "en-US", + "uuid": "322a231a-b7f7-49f5-920f-14c61199cd30", + "updatedAt": 1705615634, + "createdAt": 1654131312, + "scannedAt": 1705615584, + "content": true, + "directory": true, + "contentChangedAt": 3192854, + "hidden": 0, + "Location": [ + { + "id": 1, + "path": "/movies" + } + ] + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx index 9678365..32320a7 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library/_usage.mdx @@ -22,9 +22,61 @@ curl http://10.10.10.47:32400/library/sections/1000 \ "title1": "Movies", "viewGroup": "secondary", "viewMode": 65592, - "Directory": [], - "Type": [], - "FieldType": [] + "Directory": [ + { + "key": "search?type=1", + "title": "Search...", + "secondary": true, + "prompt": "Search Movies", + "search": true + } + ], + "Type": [ + { + "key": "/library/sections/1/all?type=1", + "type": "movie", + "title": "Movies", + "active": false, + "Filter": [ + { + "filter": "label", + "filterType": "string", + "key": "/library/sections/1/label", + "title": "Labels", + "type": "filter" + } + ], + "Sort": [ + { + "default": "asc", + "defaultDirection": "desc", + "descKey": "random:desc", + "firstCharacterKey": "/library/sections/1/firstCharacter", + "key": "random", + "title": "Randomly" + } + ], + "Field": [ + { + "key": "label", + "title": "Label", + "type": "tag", + "subType": "bitrate" + } + ] + } + ], + "FieldType": [ + { + "type": "resolution", + "Operator": [ + { + "key": "=", + "title": "is" + } + ] + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx index 56fb06d..f68c041 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx @@ -5,6 +5,8 @@ import Labels from "/src/lib/labels"; ##### `sectionId` _integer_ the Id of the library to query +
+**Example:** `1` --- ##### `tag` _enumeration_ diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx index b2b7df3..301ed60 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_response.mdx @@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index 5fc5a2c..dfd44ad 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \ +curl http://10.10.10.47:32400/library/sections/1/{{tag}} \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -25,7 +25,114 @@ curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \ "viewGroup": "movie", "viewMode": 65592, "mixedParents": true, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "58683", + "key": "/library/metadata/58683", + "guid": "plex://movie/5d7768ba96b655001fdc0408", + "studio": "20th Century Studios", + "type": "movie", + "title": "Avatar: The Way of Water", + "contentRating": "PG-13", + "summary": "Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.", + "rating": 7.6, + "audienceRating": 9.2, + "year": 2022, + "tagline": "Return to Pandora.", + "thumb": "/library/metadata/58683/thumb/1703239236", + "art": "/library/metadata/58683/art/1703239236", + "duration": 11558112, + "originallyAvailableAt": "2022-12-14T00:00:00Z", + "addedAt": 1680457607, + "updatedAt": 1703239236, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "chapterSource": "media", + "primaryExtraKey": "/library/metadata/58684", + "ratingImage": "rottentomatoes://image.rating.ripe", + "grandparentRatingKey": "66", + "grandparentGuid": "plex://show/5d9c081b170e24001f2a7be4", + "grandparentKey": "/library/metadata/66", + "grandparentTitle": "Caprica", + "grandparentThumb": "/library/metadata/66/thumb/1705716261", + "grandparentArt": "/library/metadata/66/art/1705716261", + "grandparentTheme": "/library/metadata/66/theme/1705716261", + "Media": [ + { + "id": 119534, + "duration": 11558112, + "bitrate": 25025, + "width": 3840, + "height": 2072, + "aspectRatio": 1.85, + "audioChannels": 6, + "audioCodec": "eac3", + "videoCodec": "hevc", + "videoResolution": "4k", + "container": "mkv", + "videoFrameRate": "24p", + "videoProfile": "main 10", + "Part": [ + { + "id": 119542, + "key": "/library/parts/119542/1680457526/file.mkv", + "duration": 11558112, + "file": "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv", + "size": 36158371307, + "container": "mkv", + "videoProfile": "main 10" + } + ] + } + ], + "Genre": [ + { + "tag": "Adventure" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "James Cameron" + } + ], + "Writer": [ + { + "tag": "James Cameron" + } + ], + "Role": [ + { + "tag": "Sigourney Weaver" + } + ], + "titleSort": "Whale", + "viewCount": 1, + "lastViewedAt": 1682752242, + "originalTitle": "映画 ブラッククローバー 魔法帝の剣", + "viewOffset": 5222500, + "skipCount": 1, + "index": 1, + "theme": "/library/metadata/1/theme/1705636920", + "leafCount": 14, + "viewedLeafCount": 0, + "childCount": 1, + "hasPremiumExtras": "1", + "hasPremiumPrimaryExtra": "1", + "parentRatingKey": "66", + "parentGuid": "plex://show/5d9c081b170e24001f2a7be4", + "parentStudio": "UCP", + "parentKey": "/library/metadata/66", + "parentTitle": "Caprica", + "parentIndex": 1, + "parentYear": 2010, + "parentThumb": "/library/metadata/66/thumb/1705716261", + "parentTheme": "/library/metadata/66/theme/1705716261" + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 33a3cd7..4a606a1 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/6481.72 \ +curl http://10.10.10.47:32400/library/metadata/3843.82 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -18,7 +18,167 @@ curl http://10.10.10.47:32400/library/metadata/6481.72 \ "librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5", "mediaTagPrefix": "/system/bundle/media/flags/", "mediaTagVersion": 1698860922, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "17", + "key": "/library/metadata/17", + "guid": "plex://movie/5d77683f6f4521001ea9dc53", + "studio": "Universal Pictures", + "type": "movie", + "title": "Serenity", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG-13", + "summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.", + "rating": 8.2, + "audienceRating": 9.1, + "year": 2005, + "tagline": "They aim to misbehave.", + "thumb": "/library/metadata/17/thumb/1705637165", + "art": "/library/metadata/17/art/1705637165", + "duration": 141417, + "originallyAvailableAt": "2005-09-29T00:00:00Z", + "addedAt": 1705637164, + "updatedAt": 1705637165, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "hasPremiumPrimaryExtra": "1", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 15, + "duration": 141417, + "bitrate": 2278, + "width": 1920, + "height": 814, + "aspectRatio": 2.35, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 0, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 15, + "key": "/library/parts/15/1705637151/file.mp4", + "duration": 141417, + "file": "/movies/Serenity (2005)/Serenity (2005).mp4", + "size": 40271948, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": false, + "videoProfile": "high", + "Stream": [ + { + "id": 29, + "streamType": 2, + "default": true, + "codec": "aac", + "index": 0, + "bitrate": 128, + "bitDepth": 8, + "chromaLocation": "left", + "chromaSubsampling": "14520", + "codedHeight": 816, + "codedWidth": 1920, + "colorPrimaries": "bt709", + "colorRange": "tv", + "colorSpace": "bt709", + "colorTrc": "bt709", + "frameRate": 24, + "hasScalingMatrix": false, + "height": 814, + "level": 40, + "profile": "lc", + "refFrames": 4, + "scanType": "progressive", + "streamIdentifier": "1", + "width": 1920, + "displayTitle": "English (AAC Stereo)", + "extendedDisplayTitle": "English (AAC Stereo)", + "selected": true, + "channels": 2, + "language": "English", + "languageTag": "en", + "languageCode": "eng", + "samplingRate": 44100 + } + ] + } + ] + } + ], + "Genre": [ + { + "id": 184, + "filter": "genre=184", + "tag": "Thriller" + } + ], + "Country": [ + { + "id": 116, + "filter": "country=116", + "tag": "United States of America" + } + ], + "guids": [ + { + "id": "tvdb://2337" + } + ], + "ratings": [ + { + "image": "themoviedb://image.rating", + "value": 7.4, + "type": "audience" + } + ], + "Director": [ + { + "id": 130, + "filter": "director=130", + "tag": "Joss Whedon", + "tagKey": "5d776828880197001ec90e8f", + "thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg" + } + ], + "Writer": [ + { + "id": 132, + "filter": "writer=132", + "tag": "Joss Whedon", + "tagKey": "5d776828880197001ec90e8f", + "thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg" + } + ], + "Role": [ + { + "id": 220, + "filter": "actor=220", + "tag": "Dennis Keiffer", + "tagKey": "5d77683554f42c001f8c4708", + "role": "Bar Guy (uncredited)", + "thumb": "https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg" + } + ], + "Producer": [ + { + "id": 221, + "filter": "producer=221", + "tag": "Barry Mendel", + "tagKey": "5d776826961905001eb90e2b", + "thumb": "https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg" + } + ] + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 8b42e38..a9b5288 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/202.18/children \ +curl http://10.10.10.47:32400/library/metadata/4375.87/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -32,7 +32,37 @@ curl http://10.10.10.47:32400/library/metadata/202.18/children \ "viewGroup": "season", "viewMode": 65593, "Directory": [], - "Metadata": [] + "Metadata": [ + { + "ratingKey": "66488", + "key": "/library/metadata/66488/children", + "parentRatingKey": "30072", + "guid": "plex://season/652aea6549508477c34c6000", + "parentGuid": "plex://show/5d9c09190aaccd001f8f42f0", + "parentStudio": "Amazon Studios", + "type": "season", + "title": "Season 2", + "parentKey": "/library/metadata/30072", + "parentTitle": "Reacher", + "summary": "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.", + "index": 2, + "parentIndex": 1, + "viewCount": 11, + "lastViewedAt": 1705646565, + "parentYear": 2022, + "thumb": "/library/metadata/66488/thumb/1703065033", + "art": "/library/metadata/30072/art/1705739923", + "parentThumb": "/library/metadata/30072/thumb/1705739923", + "parentTheme": "/library/metadata/30072/theme/1705739923", + "leafCount": 8, + "viewedLeafCount": 8, + "addedAt": 1702602021, + "updatedAt": 1703065033, + "userRating": 9, + "skipCount": 1, + "lastRatedAt": 1703881224 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx index e03bd90..13cfbd8 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/3373.96/refresh \ +curl http://10.10.10.47:32400/library/sections/6235.64/refresh \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx index cf771e5..f3d34f4 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx @@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx index 57b1e1b..aa8f257 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/sections/87129/search \ +curl http://10.10.10.47:32400/library/sections/645894/search \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -22,7 +22,30 @@ curl http://10.10.10.47:32400/library/sections/87129/search \ "title2": "Search for ''", "viewGroup": "season", "viewMode": 65593, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "2", + "key": "/library/metadata/2/children", + "parentRatingKey": "1", + "guid": "plex://season/602e67e766dfdb002c0a1b5b", + "parentGuid": "plex://show/5d9c086c7d06d9001ffd27aa", + "parentStudio": "Mutant Enemy Productions", + "type": "season", + "title": "Season 1", + "parentKey": "/library/metadata/1", + "parentTitle": "Firefly", + "summary": "Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.", + "index": 1, + "parentIndex": 1, + "parentYear": 2002, + "thumb": "/library/metadata/2/thumb/1705636920", + "art": "/library/metadata/1/art/1705636920", + "parentThumb": "/library/metadata/1/thumb/1705636920", + "parentTheme": "/library/metadata/1/theme/1705636920", + "addedAt": 1705636916, + "updatedAt": 1705636920 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx index 0987042..5824b0a 100644 --- a/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx @@ -5,8 +5,12 @@ the media key --- ##### `time` _number_ The time, in milliseconds, used to set the media playback progress. +
+**Example:** `90000` --- ##### `state` _string_ The playback state of the media item. +
+**Example:** `played` diff --git a/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx index f46d005..80cf941 100644 --- a/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=%3Cvalue%3E&time=7151.9 \ +curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=played&time=90000 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index 6c85d1d..c24ccf3 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ +curl http://10.10.10.47:32400/playlists/7917.25/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' ``` @@ -13,7 +13,23 @@ curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server "size": 1, "leafCountAdded": 1, "leafCountRequested": 1, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "94", + "key": "/playlists/94/items", + "guid": "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2", + "type": "playlist", + "title": "A great playlist", + "summary": "One of my great playlists", + "smart": false, + "playlistType": "video", + "composite": "/playlists/94/composite/1705800070", + "duration": 423000, + "leafCount": 3, + "addedAt": 1705716458, + "updatedAt": 1705800070 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index 9eb9cee..dfad9f8 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8700.88/items \ +curl http://10.10.10.47:32400/playlists/4776.65/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 4bcb39a..525090b 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&uri=%3Cvalue%3E \ +curl http://10.10.10.47:32400/playlists?playQueueID=2975.34&title=%3Cvalue%3E&uri=%3Cvalue%3E \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&ur { "MediaContainer": { "size": 7, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "96", + "key": "/playlists/96/items", + "guid": "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55", + "type": "playlist", + "title": "A Great Playlist", + "summary": "What a great playlist", + "smart": false, + "playlistType": "video", + "icon": "playlist://image.smart", + "viewCount": 1, + "lastViewedAt": 1705719589, + "leafCount": 1, + "addedAt": 1705719589, + "updatedAt": 1705724593, + "composite": "/playlists/96/composite/1705724593", + "duration": 141000 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 19f1a2e..5b6d6a6 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/9571.56 \ +curl http://10.10.10.47:32400/playlists/567.13 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index 0a81710..38746a2 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8326.2 \ +curl http://10.10.10.47:32400/playlists/8917.73 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,7 +11,25 @@ curl http://10.10.10.47:32400/playlists/8326.2 \ { "MediaContainer": { "size": 1, - "Metadata": [] + "Metadata": [ + { + "content": "library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1", + "ratingKey": "95", + "key": "/playlists/95/items", + "guid": "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91", + "type": "playlist", + "title": "Smart Movie Playlist", + "summary": "", + "smart": true, + "playlistType": "video", + "composite": "/playlists/95/composite/1705717387", + "icon": "playlist://image.smart", + "duration": 282000, + "leafCount": 2, + "addedAt": 1705716493, + "updatedAt": 1705717387 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index 970c485..90d2bce 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \ +curl http://10.10.10.47:32400/playlists/2726.56/items?type=3834.41 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -18,7 +18,95 @@ curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \ "ratingKey": "95", "smart": true, "title": "Smart Movie Playlist", - "Metadata": [] + "Metadata": [ + { + "ratingKey": "17", + "key": "/library/metadata/17", + "guid": "plex://movie/5d77683f6f4521001ea9dc53", + "studio": "Universal Pictures", + "type": "movie", + "title": "Serenity", + "titleSort": "Amazing Spider-Man 2", + "librarySectionTitle": "Movies", + "librarySectionID": 1, + "librarySectionKey": "/library/sections/1", + "contentRating": "PG-13", + "summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.", + "rating": 8.2, + "audienceRating": 9.1, + "year": 2005, + "tagline": "They aim to misbehave.", + "thumb": "/library/metadata/17/thumb/1705637165", + "art": "/library/metadata/17/art/1705637165", + "duration": 141416, + "originallyAvailableAt": "2005-09-29T00:00:00Z", + "addedAt": 1705637164, + "updatedAt": 1705637165, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "hasPremiumExtras": "1", + "hasPremiumPrimaryExtra": "1", + "ratingImage": "rottentomatoes://image.rating.ripe", + "Media": [ + { + "id": 15, + "duration": 141416, + "bitrate": 2273, + "width": 1920, + "height": 814, + "aspectRatio": 2.35, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "h264", + "videoResolution": "1080", + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 0, + "audioProfile": "lc", + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 15, + "key": "/library/parts/15/1705637151/file.mp4", + "duration": 141416, + "file": "/movies/Serenity (2005)/Serenity (2005).mp4", + "size": 40271948, + "audioProfile": "lc", + "container": "mp4", + "has64bitOffsets": false, + "optimizedForStreaming": false, + "videoProfile": "high" + } + ] + } + ], + "Genre": [ + { + "tag": "Action" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Director": [ + { + "tag": "Joss Whedon" + } + ], + "Writer": [ + { + "tag": "Joss Whedon" + } + ], + "Role": [ + { + "tag": "Gina Torres" + } + ] + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx index 56a868b..05c201c 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx @@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists \ { "MediaContainer": { "size": 4, - "Metadata": [] + "Metadata": [ + { + "ratingKey": "92", + "key": "/playlists/92/items", + "guid": "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903", + "type": "playlist", + "title": "Static Playlist", + "summary": "A Great Playlist", + "smart": false, + "playlistType": "video", + "composite": "/playlists/92/composite/1705716440", + "icon": "playlist://image.smart", + "viewCount": 1, + "lastViewedAt": 1705716298, + "duration": 7328000, + "leafCount": 32, + "addedAt": 1705716298, + "updatedAt": 1705716440 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index b180303..68639bc 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/7781.57?summary=%3Cvalue%3E&title=%3Cvalue%3E \ +curl http://10.10.10.47:32400/playlists/9636.63?summary=%3Cvalue%3E&title=%3Cvalue%3E \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx index 54819c7..22879a6 100644 --- a/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_parameters.mdx @@ -1,14 +1,16 @@ {/* Autogenerated DO NOT EDIT */} -##### `X-Plex-Client-Identifier` _string_ -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- ##### `strong` _boolean (optional)_ Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non\-Strong codes are used for `Plex.tv/link` +--- +##### `X-Plex-Client-Identifier` _string (optional)_ +The unique identifier for the client application +This is used to track the client application and its usage +(UUID, serial number, or other number unique per device) + +
+**Example:** `Postman` + diff --git a/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx index 9e958e1..3a6e75f 100644 --- a/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/plex/get_pin/_usage.mdx @@ -3,8 +3,7 @@ ```bash Example Request curl https://plex.tv/api/v2/pins?strong=false \ --header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' \ ---header 'X-Plex-Client-Identifier: ' +--header 'X-Plex-Client-Identifier: Postman' ``` --- diff --git a/src/.gen/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx index 03a756b..c67eb4c 100644 --- a/src/.gen/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/plex/get_token/_parameters.mdx @@ -3,9 +3,11 @@ The PinID to retrieve an access token for --- -##### `X-Plex-Client-Identifier` _string_ +##### `X-Plex-Client-Identifier` _string (optional)_ The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) +
+**Example:** `Postman` diff --git a/src/.gen/pages/01-reference/curl/resources/plex/get_token/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/plex/get_token/_usage.mdx index 2709880..5b2885a 100644 --- a/src/.gen/pages/01-reference/curl/resources/plex/get_token/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/plex/get_token/_usage.mdx @@ -3,8 +3,7 @@ ```bash Example Request curl https://plex.tv/api/v2/pins/ \ --header 'Accept: application/json' \ ---header 'X-Plex-Token: YOUR_API_KEY_HERE' \ ---header 'X-Plex-Client-Identifier: ' +--header 'X-Plex-Client-Identifier: Postman' ``` --- diff --git a/src/.gen/pages/01-reference/curl/resources/resources_content.mdx b/src/.gen/pages/01-reference/curl/resources/resources_content.mdx index dc73216..992c54d 100644 --- a/src/.gen/pages/01-reference/curl/resources/resources_content.mdx +++ b/src/.gen/pages/01-reference/curl/resources/resources_content.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/src/.gen/pages/01-reference/curl/resources/search/perform_search/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/search/perform_search/_usage.mdx index 37aeb06..ea67300 100644 --- a/src/.gen/pages/01-reference/curl/resources/search/perform_search/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/search/perform_search/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=3927.85 \ +curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=5448.83 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx index 42fb2eb..fc26f1f 100644 --- a/src/.gen/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/search/perform_voice_search/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=9255.97 \ +curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=8472.52 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/security/security.mdx b/src/.gen/pages/01-reference/curl/resources/security/security.mdx deleted file mode 100644 index 6c9b57d..0000000 --- a/src/.gen/pages/01-reference/curl/resources/security/security.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import Security from './security_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx index 23931ef..e4614a3 100644 --- a/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/server/get_server_preferences/_usage.mdx @@ -11,7 +11,20 @@ curl http://10.10.10.47:32400/:/prefs \ { "MediaContainer": { "size": 161, - "Setting": [] + "Setting": [ + { + "id": "EnableDatabaseTrace", + "label": "", + "summary": "", + "type": "bool", + "default": false, + "value": false, + "hidden": true, + "advanced": false, + "group": "", + "enumValues": "1:admin only|2:everyone" + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx index ad383cc..94918fe 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_session_history/_usage.mdx @@ -11,7 +11,29 @@ curl http://10.10.10.47:32400/status/sessions/history/all \ { "MediaContainer": { "size": 10855, - "Metadata": [] + "Metadata": [ + { + "historyKey": "/status/sessions/history/1", + "key": "/library/metadata/32171", + "ratingKey": "32171", + "librarySectionID": "2", + "parentKey": "/library/metadata/32170", + "grandparentKey": "/library/metadata/32132", + "title": "The Noise That Blue Makes", + "grandparentTitle": "Taskmaster", + "type": "episode", + "thumb": "/library/metadata/32171/thumb/-1", + "parentThumb": "/library/metadata/32170/thumb/1654134301", + "grandparentThumb": "/library/metadata/32132/thumb/1703933346", + "grandparentArt": "/library/metadata/32132/art/1703933346", + "index": 1, + "parentIndex": 13, + "originallyAvailableAt": "2022-04-14T00:00:00Z", + "viewedAt": 1654139223, + "accountID": 1, + "deviceID": 5 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx index 9488a0c..89a7f79 100644 --- a/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/sessions/get_sessions/_usage.mdx @@ -11,7 +11,118 @@ curl http://10.10.10.47:32400/status/sessions \ { "MediaContainer": { "size": 1, - "Metadata": [] + "Metadata": [ + { + "addedAt": 1705543312, + "art": "/library/metadata/39904/art/1705310687", + "duration": 186240, + "grandparentArt": "/library/metadata/39904/art/1705310687", + "grandparentGuid": "plex://artist/5d07bbfd403c6402904a6480", + "grandparentKey": "/library/metadata/39904", + "grandparentRatingKey": "39904", + "grandparentThumb": "/library/metadata/39904/thumb/1705310687", + "grandparentTitle": "Green Day", + "guid": "plex://track/6535834f71f22f36f71a8e8f", + "index": 1, + "key": "/library/metadata/67085", + "librarySectionID": "3", + "librarySectionKey": "/library/sections/3", + "librarySectionTitle": "Music", + "musicAnalysisVersion": "1", + "parentGuid": "plex://album/65394d6d472b8ab03ef47f12", + "parentIndex": 1, + "parentKey": "/library/metadata/67084", + "parentRatingKey": "67084", + "parentStudio": "Reprise Records", + "parentThumb": "/library/metadata/67084/thumb/1705543314", + "parentTitle": "Saviors", + "parentYear": 2024, + "ratingCount": 45885, + "ratingKey": "67085", + "sessionKey": "203", + "thumb": "/library/metadata/67084/thumb/1705543314", + "title": "The American Dream Is Killing Me", + "titleSort": "American Dream Is Killing Me", + "type": "track", + "updatedAt": 1705543314, + "viewOffset": 1000, + "Media": [ + { + "audioChannels": 2, + "audioCodec": "flac", + "bitrate": 1014, + "container": "flac", + "duration": 186240, + "id": "130355", + "selected": true, + "Part": [ + { + "container": "flac", + "duration": 186240, + "file": "/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac", + "hasThumbnail": "1", + "id": "130625", + "key": "/library/parts/130625/1705543268/file.flac", + "size": 23644000, + "decision": "directplay", + "selected": true, + "Stream": [ + { + "albumGain": "-12.94", + "albumPeak": "1.000000", + "albumRange": "4.751014", + "audioChannelLayout": "stereo", + "bitDepth": 16, + "bitrate": 1014, + "channels": 2, + "codec": "flac", + "displayTitle": "FLAC (Stereo)", + "extendedDisplayTitle": "FLAC (Stereo)", + "gain": "-12.94", + "id": "352487", + "index": 0, + "loudness": "-5.94", + "lra": "1.74", + "peak": "1.000000", + "samplingRate": 44100, + "selected": true, + "streamType": 2, + "location": "direct" + } + ] + } + ] + } + ], + "User": { + "id": "1", + "thumb": "https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661", + "title": "Blindkitty38" + }, + "Player": { + "address": "10.10.10.171", + "machineIdentifier": "3tsdzir85m2onc3qyr255aq1", + "model": "standalone", + "platform": "windows", + "platformVersion": "10.0.22621", + "product": "Plex for Windows", + "profile": "Plex Desktop", + "remotePublicAddress": "68.248.140.20", + "state": "playing", + "title": "DESKTOP-BL80MTD", + "version": "1.85.0.4071-21128b56", + "local": true, + "relayed": false, + "secure": true, + "userID": 1 + }, + "Session": { + "id": "93h7e00ncblxncqw9lkfaoxi", + "bandwidth": 1050, + "location": "lan" + } + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx index 855e013..6db0d79 100644 --- a/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_parameters.mdx @@ -3,4 +3,6 @@ The timespan to retrieve statistics for the exact meaning of this parameter is not known +
+**Example:** `4` diff --git a/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx index 73d1f06..70025d1 100644 --- a/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/statistics/get_statistics/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \ +curl http://10.10.10.47:32400/statistics/media?Timespan=4 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` @@ -11,9 +11,38 @@ curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \ { "MediaContainer": { "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] + "Device": [ + { + "id": 208, + "name": "Roku Express", + "platform": "Roku", + "clientIdentifier": "793095d235660625108ef785cc7646e9", + "createdAt": 1706470556 + } + ], + "Account": [ + { + "id": 238960586, + "key": "/accounts/238960586", + "name": "Diane", + "defaultAudioLanguage": "en", + "autoSelectAudio": true, + "defaultSubtitleLanguage": "en", + "subtitleMode": 1, + "thumb": "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967" + } + ], + "StatisticsMedia": [ + { + "accountID": 1, + "deviceID": 13, + "timespan": 4, + "at": 1707141600, + "metadataType": 4, + "count": 1, + "duration": 1555 + } + ] } } ``` diff --git a/src/.gen/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx index 736472f..82d4909 100644 --- a/src/.gen/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/updater/apply_updates/_parameters.mdx @@ -6,6 +6,8 @@ import Labels from "/src/lib/labels"; ##### `tonight` _enumeration (optional)_ Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install +
+**Example:** `1` @@ -14,6 +16,8 @@ Indicate that you want the update to run during the next Butler execution. Omitt --- ##### `skip` _enumeration (optional)_ Indicate that the latest version should be marked as skipped. The \ entry for this version will have the `state` set to `skipped`. +
+**Example:** `1` diff --git a/src/.gen/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx index 2470ae2..3ad5918 100644 --- a/src/.gen/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/updater/check_for_updates/_parameters.mdx @@ -5,6 +5,8 @@ import Labels from "/src/lib/labels"; ##### `download` _enumeration (optional)_ Indicate that you want to start download any updates found. +
+**Example:** `1` diff --git a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx index 3a91bd8..2cee9b6 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_parameters.mdx @@ -5,14 +5,20 @@ import Labels from "/src/lib/labels"; ##### `ratingKey` _number_ The rating key of the media item +
+**Example:** `23409` --- ##### `key` _string_ The key of the media item to get the timeline for +
+**Example:** `/library/metadata/23409` --- ##### `state` _enumeration_ The state of the media item +
+**Example:** `playing` @@ -21,28 +27,42 @@ The state of the media item --- ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `time` _number_ The time of the media item +
+**Example:** `2000` --- ##### `duration` _number_ The duration of the media item +
+**Example:** `10000` --- ##### `context` _string_ The context of the media item +
+**Example:** `home:hub.continueWatching` --- ##### `playQueueItemID` _number_ The play queue item ID of the media item +
+**Example:** `1` --- ##### `playBackTime` _number_ The playback time of the media item +
+**Example:** `2000` --- ##### `row` _number_ The row of the media item +
+**Example:** `1` diff --git a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index 8662e16..ed331b1 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=%3Cvalue%3E&duration=5448.83&hasMDE=6027.63&key=%3Cvalue%3E&playBackTime=4236.55&playQueueItemID=8472.52&ratingKey=8442.66&row=6235.64&time=8579.46 \ +curl http://10.10.10.47:32400/:/timeline?context=home%3Ahub.continueWatching&duration=10000&hasMDE=1&key=%2Flibrary%2Fmetadata%2F23409&playBackTime=2000&playQueueItemID=1&ratingKey=23409&row=1&time=2000 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx index bc4914e..9b5a10a 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_parameters.mdx @@ -1,64 +1,96 @@ {/* Autogenerated DO NOT EDIT */} ##### `hasMDE` _number_ Whether the media item has MDE +
+**Example:** `1` --- ##### `path` _string_ The path to the media item to transcode +
+**Example:** `/library/metadata/23409` --- ##### `mediaIndex` _number_ The index of the media item to transcode +
+**Example:** `0` --- ##### `partIndex` _number_ The index of the part to transcode +
+**Example:** `0` --- ##### `protocol` _string_ The protocol to use for the transcode session +
+**Example:** `hls` --- ##### `fastSeek` _number (optional)_ Whether to use fast seek or not +
+**Example:** `0` --- ##### `directPlay` _number (optional)_ Whether to use direct play or not +
+**Example:** `0` --- ##### `directStream` _number (optional)_ Whether to use direct stream or not +
+**Example:** `0` --- ##### `subtitleSize` _number (optional)_ The size of the subtitles +
+**Example:** `100` --- ##### `subtites` _string (optional)_ The subtitles +
+**Example:** `burn` --- ##### `audioBoost` _number (optional)_ The audio boost +
+**Example:** `100` --- ##### `location` _string (optional)_ The location of the transcode session +
+**Example:** `lan` --- ##### `mediaBufferSize` _number (optional)_ The size of the media buffer +
+**Example:** `102400` --- ##### `session` _string (optional)_ The session ID +
+**Example:** `zvcage8b7rkioqcm8f4uns4c` --- ##### `addDebugOverlay` _number (optional)_ Whether to add a debug overlay or not +
+**Example:** `0` --- ##### `autoAdjustQuality` _number (optional)_ Whether to auto adjust quality or not +
+**Example:** `0` diff --git a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index 3fd4b2e..4e744a9 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4776.65&audioBoost=2726.56&autoAdjustQuality=7917.25&directPlay=8917.73&directStream=567.13&fastSeek=2975.34&hasMDE=6458.94&location=%3Cvalue%3E&mediaBufferSize=3834.41&mediaIndex=3843.82&partIndex=4375.87&path=%3Cvalue%3E&protocol=%3Cvalue%3E&session=%3Cvalue%3E&subtites=%3Cvalue%3E&subtitleSize=9636.63 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=0&audioBoost=100&autoAdjustQuality=0&directPlay=0&directStream=0&fastSeek=0&hasMDE=1&location=lan&mediaBufferSize=102400&mediaIndex=0&partIndex=0&path=%2Flibrary%2Fmetadata%2F23409&protocol=hls&session=zvcage8b7rkioqcm8f4uns4c&subtites=burn&subtitleSize=100 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/go/errors/_snippet.mdx b/src/.gen/pages/01-reference/go/errors/_snippet.mdx index 52edff7..6f958d4 100644 --- a/src/.gen/pages/01-reference/go/errors/_snippet.mdx +++ b/src/.gen/pages/01-reference/go/errors/_snippet.mdx @@ -12,7 +12,6 @@ import ( "context" "errors" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "github.com/LukeHagar/plexgo/models/sdkerrors" "log" ) @@ -20,6 +19,7 @@ import ( func main() { s := plexgo.New( plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() diff --git a/src/.gen/pages/01-reference/go/global_parameters/_snippet.mdx b/src/.gen/pages/01-reference/go/global_parameters/_snippet.mdx new file mode 100644 index 0000000..1ce2583 --- /dev/null +++ b/src/.gen/pages/01-reference/go/global_parameters/_snippet.mdx @@ -0,0 +1,36 @@ +{/* Start Go Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```go +package main + +import ( + "context" + "github.com/LukeHagar/plexgo" + "log" +) + +func main() { + s := plexgo.New( + plexgo.WithXPlexClientIdentifier("Postman"), + ) + var strong *bool = plexgo.Bool(false) + + var xPlexClientIdentifier *string = plexgo.String("Postman") + ctx := context.Background() + res, err := s.Plex.GetPin(ctx, strong, xPlexClientIdentifier) + if err != nil { + log.Fatal(err) + } + if res.Object != nil { + // handle response + } +} + +``` +{/* End Go Global Parameters */} diff --git a/src/.gen/pages/01-reference/go/global_parameters/global_parameters.mdx b/src/.gen/pages/01-reference/go/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..00d772b --- /dev/null +++ b/src/.gen/pages/01-reference/go/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import GlobalParameters from './global_parameters_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/go/global_parameters/global_parameters_content.mdx b/src/.gen/pages/01-reference/go/global_parameters/global_parameters_content.mdx new file mode 100644 index 0000000..6bd22f5 --- /dev/null +++ b/src/.gen/pages/01-reference/go/global_parameters/global_parameters_content.mdx @@ -0,0 +1,12 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* rendered from global_parameters template */} + +import Snippet from "./_snippet.mdx"; + + + +{/* end rendered section */} \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/go_content.mdx b/src/.gen/pages/01-reference/go/go_content.mdx index b133698..a55934b 100644 --- a/src/.gen/pages/01-reference/go/go_content.mdx +++ b/src/.gen/pages/01-reference/go/go_content.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/src/.gen/pages/01-reference/go/resources/authentication/authentication.mdx b/src/.gen/pages/01-reference/go/resources/authentication/authentication.mdx new file mode 100644 index 0000000..42e7802 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/authentication.mdx @@ -0,0 +1,6 @@ +import Authentication from './authentication_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/content/pages/01-reference/curl/resources/security/security.mdx b/src/.gen/pages/01-reference/go/resources/authentication/authentication_content.mdx similarity index 50% rename from content/pages/01-reference/curl/resources/security/security.mdx rename to src/.gen/pages/01-reference/go/resources/authentication/authentication_content.mdx index 8f7bfb3..ee8a683 100644 --- a/content/pages/01-reference/curl/resources/security/security.mdx +++ b/src/.gen/pages/01-reference/go/resources/authentication/authentication_content.mdx @@ -1,14 +1,14 @@ import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; -## Security -API Calls against Security for Plex Media Server +## Authentication +API Calls regarding authentication for Plex Media Server ### Available Operations -* [Get Transient Token](/curl/security/get_transient_token) - Get a Transient Token. -* [Get Source Connection Information](/curl/security/get_source_connection_information) - Get Source Connection Information +* [Get Transient Token](/go/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/go/authentication/get_source_connection_information) - Get Source Connection Information --- diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx new file mode 100644 index 0000000..8b0f80b --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_parameters.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) +The context to use for the request. + +--- +##### `source` *{`string`}* +The source identifier with an included prefix. +
+**Example:** `server://client-identifier` + diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..a4d2b63 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`*operations.GetSourceConnectionInformationResponse`}* + + + + + + +--- +##### *{`error`}* + + diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx new file mode 100644 index 0000000..b892456 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/_usage.mdx @@ -0,0 +1,42 @@ + + +```go GetSourceConnectionInformation.go +package main + +import( + "github.com/LukeHagar/plexgo" + "context" + "log" +) + +func main() { + s := plexgo.New( + plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), + ) + var source string = "provider://provider-identifier" + ctx := context.Background() + res, err := s.Authentication.GetSourceConnectionInformation(ctx, source) + if err != nil { + log.Fatal(err) + } + if res != nil { + // handle response + } +} +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 100% rename from src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information.mdx rename to src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information.mdx diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..75f5abe --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,25 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/go.mdx" +import Scope from "/content/types/models/operations/scope/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. + +--- +##### `type_` *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope` *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + diff --git a/content/pages/01-reference/go/resources/plex/get_pin/_response.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx similarity index 58% rename from content/pages/01-reference/go/resources/plex/get_pin/_response.mdx rename to src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx index 6e5769b..ed38c60 100644 --- a/content/pages/01-reference/go/resources/plex/get_pin/_response.mdx +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_response.mdx @@ -1,12 +1,12 @@ {/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/go.mdx" +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/go.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### *{`*operations.GetPinResponse`}* +##### *{`*operations.GetTransientTokenResponse`}* - + diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..1227883 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,45 @@ + + +```go GetTransientToken.go +package main + +import( + "github.com/LukeHagar/plexgo" + "github.com/LukeHagar/plexgo/models/operations" + "context" + "log" +) + +func main() { + s := plexgo.New( + plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), + ) + var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation + + var scope operations.Scope = operations.ScopeAll + ctx := context.Background() + res, err := s.Authentication.GetTransientToken(ctx, type_, scope) + if err != nil { + log.Fatal(err) + } + if res != nil { + // handle response + } +} +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 100% rename from src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token.mdx rename to src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token.mdx diff --git a/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/authentication/get_transient_token/get_transient_token_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_header.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_header.mdx index 5c6a65f..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_header.mdx @@ -1,3 +1 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx index 6fd9d82..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_parameters.mdx @@ -1,22 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `xPlexClientIdentifier` *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong` *{`*bool`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `opts` *{`[]operations.Option`}* -The options for this request. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_response.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_response.mdx index 6e5769b..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_response.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_response.mdx @@ -1,16 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetPinResponse`}* - - - - - - ---- -##### *{`error`}* - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_usage.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_usage.mdx index 23aa07c..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_pin/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_pin/_usage.mdx @@ -1,63 +1 @@ - - -```go GetPin.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var xPlexClientIdentifier string = "" - - var strong *bool = plexgo.Bool(false) - - ctx := context.Background() - res, err := s.Plex.GetPin(ctx, xPlexClientIdentifier, strong) - if err != nil { - log.Fatal(err) - } - - if res.Object != nil { - // handle response - } -} -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_pin/get_pin_content.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_pin/get_pin_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_pin/get_pin_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_pin/get_pin_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_token/_header.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_token/_header.mdx index 17a7e70..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_token/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_token/_header.mdx @@ -1,3 +1 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_token/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_token/_parameters.mdx index d1c43ed..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_token/_parameters.mdx @@ -1,19 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `pinID` *{`string`}* -The PinID to retrieve an access token for - ---- -##### `xPlexClientIdentifier` *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `opts` *{`[]operations.Option`}* -The options for this request. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_token/_response.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_token/_response.mdx index f91fd35..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_token/_response.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_token/_response.mdx @@ -1,16 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetTokenResponse`}* - - - - - - ---- -##### *{`error`}* - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_token/_usage.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_token/_usage.mdx index 3707391..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_token/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_token/_usage.mdx @@ -1,48 +1 @@ - - -```go GetToken.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" - "net/http" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var pinID string = "" - - var xPlexClientIdentifier string = "" - - ctx := context.Background() - res, err := s.Plex.GetToken(ctx, pinID, xPlexClientIdentifier) - if err != nil { - log.Fatal(err) - } - - if res.StatusCode == http.StatusOK { - // handle response - } -} -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 - } - ] - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/plex/get_token/get_token_content.mdx b/src/.gen/pages/01-reference/go/resources/plex/get_token/get_token_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/plex/get_token/get_token_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/plex/get_token/get_token_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/resources_content.mdx b/src/.gen/pages/01-reference/go/resources/resources_content.mdx index dc73216..992c54d 100644 --- a/src/.gen/pages/01-reference/go/resources/resources_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/resources_content.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/get_source_connection_information_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_response.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/get_transient_token_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/security/security.mdx b/src/.gen/pages/01-reference/go/resources/security/security.mdx deleted file mode 100644 index 6c9b57d..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/security.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import Security from './security_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/go/resources/security/security_content.mdx b/src/.gen/pages/01-reference/go/resources/security/security_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/go/resources/security/security_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx index c9ff431..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_header.mdx @@ -1,3 +1 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx index b880469..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_parameters.mdx @@ -1,10 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) -The context to use for the request. - ---- -##### `timespan` *{`*int64`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx index e73915f..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_response.mdx @@ -1,16 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/go.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`*operations.GetStatisticsResponse`}* - - - - - - ---- -##### *{`error`}* - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx index 75e2458..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/_usage.mdx @@ -1,44 +1 @@ - - -```go GetStatistics.go -package main - -import( - "github.com/LukeHagar/plexgo/models/components" - "github.com/LukeHagar/plexgo" - "context" - "log" -) - -func main() { - s := plexgo.New( - plexgo.WithSecurity(""), - ) - - - var timespan *int64 = plexgo.Int64(944669) - - ctx := context.Background() - res, err := s.Statistics.GetStatistics(ctx, timespan) - if err != nil { - log.Fatal(err) - } - - if res.Object != nil { - // handle response - } -} -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/get_statistics_content.mdx b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/get_statistics_content.mdx index 723ef2d..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/get_statistics_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/get_statistics/get_statistics_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/resources/statistics/statistics_content.mdx b/src/.gen/pages/01-reference/go/resources/statistics/statistics_content.mdx index 7da9a99..ec747fa 100644 --- a/src/.gen/pages/01-reference/go/resources/statistics/statistics_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/statistics/statistics_content.mdx @@ -1,12 +1 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/go/statistics/get_statistics) - Get Media Statistics - ---- - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/go/security_options/_snippet.mdx b/src/.gen/pages/01-reference/go/security_options/_snippet.mdx index ffbdb5c..f33427e 100644 --- a/src/.gen/pages/01-reference/go/security_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/go/security_options/_snippet.mdx @@ -18,6 +18,7 @@ import ( func main() { s := plexgo.New( plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -25,7 +26,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } diff --git a/src/.gen/pages/01-reference/go/server_options/_snippet.mdx b/src/.gen/pages/01-reference/go/server_options/_snippet.mdx index da8f920..a767908 100644 --- a/src/.gen/pages/01-reference/go/server_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/go/server_options/_snippet.mdx @@ -14,7 +14,6 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "log" ) @@ -22,6 +21,7 @@ func main() { s := plexgo.New( plexgo.WithServerIndex(0), plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -29,7 +29,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } @@ -53,7 +52,6 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" "log" ) @@ -61,6 +59,7 @@ func main() { s := plexgo.New( plexgo.WithServerURL("{protocol}://{ip}:{port}"), plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) ctx := context.Background() @@ -68,7 +67,6 @@ func main() { if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } @@ -85,25 +83,22 @@ package main import ( "context" "github.com/LukeHagar/plexgo" - "github.com/LukeHagar/plexgo/models/components" + "github.com/LukeHagar/plexgo/models/operations" "log" ) func main() { s := plexgo.New( - plexgo.WithSecurity(""), + plexgo.WithXPlexClientIdentifier("Postman"), ) - - var xPlexClientIdentifier string = "" - var strong *bool = plexgo.Bool(false) + var xPlexClientIdentifier *string = plexgo.String("Postman") ctx := context.Background() - res, err := s.Plex.GetPin(ctx, operations.WithServerURL("https://plex.tv/api/v2"), xPlexClientIdentifier, strong) + res, err := s.Plex.GetPin(ctx, strong, xPlexClientIdentifier, operations.WithServerURL("https://plex.tv/api/v2")) if err != nil { log.Fatal(err) } - if res.Object != nil { // handle response } diff --git a/src/.gen/pages/01-reference/python/custom_http_client/_snippet.mdx b/src/.gen/pages/01-reference/python/custom_http_client/_snippet.mdx index 7e3a156..bc53609 100644 --- a/src/.gen/pages/01-reference/python/custom_http_client/_snippet.mdx +++ b/src/.gen/pages/01-reference/python/custom_http_client/_snippet.mdx @@ -8,6 +8,6 @@ import requests http_client = requests.Session() http_client.headers.update({'x-custom-header': 'someValue'}) -s = plex_api.PlexAPI(client: http_client) +s = plex_api.PlexAPI(client=http_client) ``` {/* End Python Custom HTTP Client */} diff --git a/src/.gen/pages/01-reference/python/errors/_snippet.mdx b/src/.gen/pages/01-reference/python/errors/_snippet.mdx index 9f01e79..0ddf205 100644 --- a/src/.gen/pages/01-reference/python/errors/_snippet.mdx +++ b/src/.gen/pages/01-reference/python/errors/_snippet.mdx @@ -11,12 +11,13 @@ from plex_api.models import errors s = plex_api.PlexAPI( access_token="", + x_plex_client_identifier='Postman', ) - res = None try: res = s.server.get_server_capabilities() + except errors.GetServerCapabilitiesResponseBody as e: # handle exception raise(e) @@ -27,6 +28,7 @@ except errors.SDKError as e: if res.object is not None: # handle response pass + ``` {/* End Python Errors */} diff --git a/src/.gen/pages/01-reference/python/global_parameters/_snippet.mdx b/src/.gen/pages/01-reference/python/global_parameters/_snippet.mdx new file mode 100644 index 0000000..a9f99b5 --- /dev/null +++ b/src/.gen/pages/01-reference/python/global_parameters/_snippet.mdx @@ -0,0 +1,24 @@ +{/* Start Python Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `'Postman'` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```python +import plex_api + +s = plex_api.PlexAPI( + x_plex_client_identifier='Postman', +) + + +res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman') + +if res.object is not None: + # handle response + pass + +``` +{/* End Python Global Parameters */} diff --git a/src/.gen/pages/01-reference/python/global_parameters/global_parameters.mdx b/src/.gen/pages/01-reference/python/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..00d772b --- /dev/null +++ b/src/.gen/pages/01-reference/python/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import GlobalParameters from './global_parameters_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/python/global_parameters/global_parameters_content.mdx b/src/.gen/pages/01-reference/python/global_parameters/global_parameters_content.mdx new file mode 100644 index 0000000..6bd22f5 --- /dev/null +++ b/src/.gen/pages/01-reference/python/global_parameters/global_parameters_content.mdx @@ -0,0 +1,12 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* rendered from global_parameters template */} + +import Snippet from "./_snippet.mdx"; + + + +{/* end rendered section */} \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/python_content.mdx b/src/.gen/pages/01-reference/python/python_content.mdx index b133698..a55934b 100644 --- a/src/.gen/pages/01-reference/python/python_content.mdx +++ b/src/.gen/pages/01-reference/python/python_content.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/src/.gen/pages/01-reference/python/resources/authentication/authentication.mdx b/src/.gen/pages/01-reference/python/resources/authentication/authentication.mdx new file mode 100644 index 0000000..42e7802 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/authentication.mdx @@ -0,0 +1,6 @@ +import Authentication from './authentication_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/python/resources/authentication/authentication_content.mdx b/src/.gen/pages/01-reference/python/resources/authentication/authentication_content.mdx new file mode 100644 index 0000000..fd6a3bf --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/authentication_content.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/python/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/python/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx new file mode 100644 index 0000000..3b26ff4 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_parameters.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} +##### `source` *{`str`}* +The source identifier with an included prefix. +
+**Example:** `server://client-identifier` + diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..b33c252 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`operations.GetSourceConnectionInformationResponse`}* + + + + + + + diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx new file mode 100644 index 0000000..432f56e --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/_usage.mdx @@ -0,0 +1,33 @@ + + +```python GetSourceConnectionInformation.py +import plex_api + +s = plex_api.PlexAPI( + access_token="", + x_plex_client_identifier='Postman', +) + + +res = s.authentication.get_source_connection_information(source='provider://provider-identifier') + +if res is not None: + # handle response + pass + +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 100% rename from src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information.mdx rename to src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information.mdx diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..05f54a2 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,21 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/python.mdx" +import Scope from "/content/types/models/operations/scope/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type` *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope` *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + diff --git a/content/pages/01-reference/python/resources/plex/get_token/_response.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx similarity index 55% rename from content/pages/01-reference/python/resources/plex/get_token/_response.mdx rename to src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx index 9a48813..2668a89 100644 --- a/content/pages/01-reference/python/resources/plex/get_token/_response.mdx +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_response.mdx @@ -1,12 +1,12 @@ {/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/python.mdx" +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/python.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### *{`operations.GetTokenResponse`}* +##### *{`operations.GetTransientTokenResponse`}* - + diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..0f1e577 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,34 @@ + + +```python GetTransientToken.py +import plex_api +from plex_api.models import operations + +s = plex_api.PlexAPI( + access_token="", + x_plex_client_identifier='Postman', +) + + +res = s.authentication.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) + +if res is not None: + # handle response + pass + +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 100% rename from src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token.mdx rename to src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token.mdx diff --git a/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/authentication/get_transient_token/get_transient_token_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_header.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_header.mdx index 5c6a65f..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_header.mdx @@ -1,3 +1 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx index 7c3c933..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_parameters.mdx @@ -1,18 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `x_plex_client_identifier` *{`str`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong` *{`Optional[bool]`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `server_url` *{`Optional[str]`}* -An optional server URL to use. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_response.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_response.mdx index aa52594..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_response.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetPinResponse`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_usage.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_usage.mdx index e9b4f03..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_pin/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_pin/_usage.mdx @@ -1,46 +1 @@ - - -```python GetPin.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.plex.get_pin(x_plex_client_identifier='', strong=False) - -if res.object is not None: - # handle response - pass -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_pin/get_pin_content.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_pin/get_pin_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_pin/get_pin_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_pin/get_pin_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_token/_header.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_token/_header.mdx index 17a7e70..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_token/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_token/_header.mdx @@ -1,3 +1 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_token/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_token/_parameters.mdx index 53d81c7..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_token/_parameters.mdx @@ -1,15 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `pin_id` *{`str`}* -The PinID to retrieve an access token for - ---- -##### `x_plex_client_identifier` *{`str`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `server_url` *{`Optional[str]`}* -An optional server URL to use. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_token/_response.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_token/_response.mdx index 9a48813..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_token/_response.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_token/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetTokenResponse`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_token/_usage.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_token/_usage.mdx index 5365593..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_token/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_token/_usage.mdx @@ -1,30 +1 @@ - - -```python GetToken.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.plex.get_token(pin_id='', x_plex_client_identifier='') - -if res.status_code == 200: - # handle response - pass -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 - } - ] - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/plex/get_token/get_token_content.mdx b/src/.gen/pages/01-reference/python/resources/plex/get_token/get_token_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/plex/get_token/get_token_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/plex/get_token/get_token_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/resources_content.mdx b/src/.gen/pages/01-reference/python/resources/resources_content.mdx index dc73216..992c54d 100644 --- a/src/.gen/pages/01-reference/python/resources/resources_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/resources_content.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/get_source_connection_information_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_response.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/get_transient_token_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/security/security.mdx b/src/.gen/pages/01-reference/python/resources/security/security.mdx deleted file mode 100644 index 6c9b57d..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/security.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import Security from './security_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/python/resources/security/security_content.mdx b/src/.gen/pages/01-reference/python/resources/security/security_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/python/resources/security/security_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx index c9ff431..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_header.mdx @@ -1,3 +1 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx index abeb7eb..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_parameters.mdx @@ -1,6 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `timespan` *{`Optional[int]`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx index ba7403e..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/python.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`operations.GetStatisticsResponse`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx index 50246c5..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/_usage.mdx @@ -1,29 +1 @@ - - -```python GetStatistics.py -import plex_api - -s = plex_api.PlexAPI( - access_token="", -) - - -res = s.statistics.get_statistics(timespan=944669) - -if res.object is not None: - # handle response - pass -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/get_statistics_content.mdx b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/get_statistics_content.mdx index 723ef2d..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/get_statistics_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/get_statistics/get_statistics_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/resources/statistics/statistics_content.mdx b/src/.gen/pages/01-reference/python/resources/statistics/statistics_content.mdx index 665a72a..ec747fa 100644 --- a/src/.gen/pages/01-reference/python/resources/statistics/statistics_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/statistics/statistics_content.mdx @@ -1,12 +1 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/python/statistics/get_statistics) - Get Media Statistics - ---- - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/python/security_options/_snippet.mdx b/src/.gen/pages/01-reference/python/security_options/_snippet.mdx index a252a06..757f25e 100644 --- a/src/.gen/pages/01-reference/python/security_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/python/security_options/_snippet.mdx @@ -11,6 +11,7 @@ import plex_api s = plex_api.PlexAPI( access_token="", + x_plex_client_identifier='Postman', ) @@ -19,5 +20,6 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` {/* End Python Security Options */} diff --git a/src/.gen/pages/01-reference/python/server_options/_snippet.mdx b/src/.gen/pages/01-reference/python/server_options/_snippet.mdx index a632230..75d248a 100644 --- a/src/.gen/pages/01-reference/python/server_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/python/server_options/_snippet.mdx @@ -14,6 +14,7 @@ import plex_api s = plex_api.PlexAPI( server_idx=0, access_token="", + x_plex_client_identifier='Postman', ) @@ -22,6 +23,7 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` #### Variables @@ -40,6 +42,7 @@ import plex_api s = plex_api.PlexAPI( server_url="{protocol}://{ip}:{port}", access_token="", + x_plex_client_identifier='Postman', ) @@ -48,6 +51,7 @@ res = s.server.get_server_capabilities() if res.object is not None: # handle response pass + ``` ### Override Server URL Per-Operation @@ -57,14 +61,15 @@ The server URL can also be overridden on a per-operation basis, provided a serve import plex_api s = plex_api.PlexAPI( - access_token="", + x_plex_client_identifier='Postman', ) -res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='', strong=False) +res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman', server_url="https://plex.tv/api/v2") if res.object is not None: # handle response pass + ``` {/* End Python Server Options */} diff --git a/src/.gen/pages/01-reference/typescript/custom_http_client/_snippet.mdx b/src/.gen/pages/01-reference/typescript/custom_http_client/_snippet.mdx index d0bfc8c..e57d258 100644 --- a/src/.gen/pages/01-reference/typescript/custom_http_client/_snippet.mdx +++ b/src/.gen/pages/01-reference/typescript/custom_http_client/_snippet.mdx @@ -26,7 +26,7 @@ const httpClient = new HTTPClient({ httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { - signal: request.signal || AbortSignal.timeout(5000); + signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); diff --git a/src/.gen/pages/01-reference/typescript/errors/_snippet.mdx b/src/.gen/pages/01-reference/typescript/errors/_snippet.mdx index 1c820c0..18898f6 100644 --- a/src/.gen/pages/01-reference/typescript/errors/_snippet.mdx +++ b/src/.gen/pages/01-reference/typescript/errors/_snippet.mdx @@ -3,21 +3,31 @@ All SDK methods return a response object or throw an error. If Error objects are -Example +Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. + ```typescript import { PlexAPI } from "@lukehagar/plexjs"; +import * as errors from "@lukehagar/plexjs/models/errors"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - let result; try { - result = await sdk.server.getServerCapabilities(); + result = await plexAPI.server.getServerCapabilities(); } catch (err) { switch (true) { + case err instanceof errors.SDKValidationError: { + // Validation errors can be pretty-printed + console.error(err.pretty()); + // Raw value may also be inspected + console.error(err.rawValue); + return; + } case err instanceof errors.GetServerCapabilitiesResponseBody: { console.error(err); // handle exception return; diff --git a/src/.gen/pages/01-reference/typescript/global_parameters/_snippet.mdx b/src/.gen/pages/01-reference/typescript/global_parameters/_snippet.mdx new file mode 100644 index 0000000..9388606 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/global_parameters/_snippet.mdx @@ -0,0 +1,26 @@ +{/* Start Typescript Global Parameters */} +A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. + +For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. + + + + +```typescript +import { PlexAPI } from "@lukehagar/plexjs"; + +const plexAPI = new PlexAPI({ + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.plex.getPin(false, "Postman"); + + // Handle the result + console.log(result); +} + +run(); + +``` +{/* End Typescript Global Parameters */} diff --git a/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters.mdx b/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters.mdx new file mode 100644 index 0000000..00d772b --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters.mdx @@ -0,0 +1,6 @@ +import GlobalParameters from './global_parameters_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters_content.mdx b/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters_content.mdx new file mode 100644 index 0000000..6bd22f5 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/global_parameters/global_parameters_content.mdx @@ -0,0 +1,12 @@ +import LanguageSelector from 'src/components/LanguageSelector'; +import { H2 } from "src/components/TextHeaderWrapper"; + +

Global Parameters

+ +{/* rendered from global_parameters template */} + +import Snippet from "./_snippet.mdx"; + + + +{/* end rendered section */} \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/authentication.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/authentication.mdx new file mode 100644 index 0000000..42e7802 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/authentication.mdx @@ -0,0 +1,6 @@ +import Authentication from './authentication_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/authentication_content.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/authentication_content.mdx new file mode 100644 index 0000000..f55542e --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/authentication_content.mdx @@ -0,0 +1,17 @@ +import GetTransientToken from "./get_transient_token/get_transient_token.mdx"; +import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx"; + +## Authentication +API Calls regarding authentication for Plex Media Server + + +### Available Operations + +* [Get Transient Token](/typescript/authentication/get_transient_token) - Get a Transient Token. +* [Get Source Connection Information](/typescript/authentication/get_source_connection_information) - Get Source Connection Information + +--- + + +--- + diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx new file mode 100644 index 0000000..b141a62 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_header.mdx @@ -0,0 +1,4 @@ +## Get Source Connection Information + +If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. +Note: requires Plex Media Server >= 1.15.4. diff --git a/content/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx similarity index 53% rename from content/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx rename to src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx index ed49299..f3ecef9 100644 --- a/content/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_parameters.mdx @@ -1,13 +1,8 @@ {/* Autogenerated DO NOT EDIT */} -##### `pinID`: *{`string`}* -The PinID to retrieve an access token for - ---- -##### `xPlexClientIdentifier`: *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - +##### `source`: *{`string`}* +The source identifier with an included prefix. +
+**Example:** `[object Object]` --- ##### `options?`: *{`RequestOptions`}* @@ -17,7 +12,3 @@ Options for making HTTP requests. ##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. ---- -##### `options.serverURL?`: *{`string`}* -An optional server URL to use. - diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx new file mode 100644 index 0000000..38e81ec --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`Promise\`}* + + + + + + + diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx new file mode 100644 index 0000000..332f1a1 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/_usage.mdx @@ -0,0 +1,34 @@ + + +```typescript GetSourceConnectionInformation.ts +import { PlexAPI } from "@lukehagar/plexjs"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.authentication.getSourceConnectionInformation("provider://provider-identifier"); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx similarity index 100% rename from src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information.mdx rename to src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information.mdx diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_source_connection_information/get_source_connection_information_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx new file mode 100644 index 0000000..8cc99db --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_header.mdx @@ -0,0 +1,3 @@ +## Get Transient Token + +This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx new file mode 100644 index 0000000..f8aa661 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_parameters.mdx @@ -0,0 +1,29 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx" +import Scope from "/content/types/models/operations/scope/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `type`: *{`operations.GetTransientTokenQueryParamType`}* +`delegation` \- This is the only supported `type` parameter. + + + + + +--- +##### `scope`: *{`operations.Scope`}* +`all` \- This is the only supported `scope` parameter. + + + + + +--- +##### `options?`: *{`RequestOptions`}* +Options for making HTTP requests. + +--- +##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) +Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. + diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx new file mode 100644 index 0000000..1293adc --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`Promise\`}* + + + + + + + diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx new file mode 100644 index 0000000..36da46c --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/_usage.mdx @@ -0,0 +1,35 @@ + + +```typescript GetTransientToken.ts +import { PlexAPI } from "@lukehagar/plexjs"; +import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; + +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); + +async function run() { + const result = await plexAPI.authentication.getTransientToken(GetTransientTokenQueryParamType.Delegation, Scope.All); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ], + "HttpMeta": {} + } +``` + diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx similarity index 100% rename from src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token.mdx rename to src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token.mdx diff --git a/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token_content.mdx new file mode 100644 index 0000000..15884bf --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/authentication/get_transient_token/get_transient_token_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Authentication* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx index 5c6a65f..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_header.mdx @@ -1,3 +1 @@ -## Get Pin - -Retrieve a Pin from Plex.tv for authentication flows \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx index b45d4b5..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_parameters.mdx @@ -1,26 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `xPlexClientIdentifier`: *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `strong?`: *{`boolean`}* -Determines the kind of code returned by the API call -Strong codes are used for Pin authentication flows -Non\-Strong codes are used for `Plex.tv/link` - - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - ---- -##### `options.serverURL?`: *{`string`}* -An optional server URL to use. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx index 6d93dd4..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetPinResponse from "/content/types/models/operations/get_pin_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx index 2cbbc54..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/_usage.mdx @@ -1,51 +1 @@ - - -```typescript GetPin.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const xPlexClientIdentifier = ""; - const strong = false; - - const result = await sdk.plex.getPin(xPlexClientIdentifier, strong); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "id": 1272322473, - "code": "3patfx1a78ukcbr7x0n9bl26t", - "product": "Plex Web", - "trusted": false, - "qr": "https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t", - "clientIdentifier": "Postman", - "location": { - "code": "US", - "european_union_member": false, - "continent_code": "NA", - "country": "United States", - "city": "Austin", - "time_zone": "America/Chicago", - "postal_code": 78732, - "in_privacy_restricted_country": false, - "subdivisions": "Texas", - "coordinates": "30.3768 -97.8935" - }, - "expiresIn": 1800, - "createdAt": "2023-04-12T17:00:03Z", - "expiresAt": "2023-04-12T17:30:03Z", - "authToken": "None", - "newRegistration": "None" - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/get_pin_content.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/get_pin_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/get_pin_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_pin/get_pin_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_header.mdx index 17a7e70..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_header.mdx @@ -1,3 +1 @@ -## Get Token - -Retrieve an Access Token from Plex.tv after the Pin has already been authenticated \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx index ed49299..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_parameters.mdx @@ -1,23 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `pinID`: *{`string`}* -The PinID to retrieve an access token for - ---- -##### `xPlexClientIdentifier`: *{`string`}* -The unique identifier for the client application -This is used to track the client application and its usage -(UUID, serial number, or other number unique per device) - - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - ---- -##### `options.serverURL?`: *{`string`}* -An optional server URL to use. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_response.mdx index e733907..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_response.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetTokenResponse from "/content/types/models/operations/get_token_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx index 1912999..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/_usage.mdx @@ -1,36 +1 @@ - - -```typescript GetToken.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const pinID = ""; - const xPlexClientIdentifier = ""; - - const result = await sdk.plex.getToken(pinID, xPlexClientIdentifier); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "errors": [ - { - "code": 1000, - "message": "X-Plex-Client-Identifier is missing", - "status": 400 - } - ], - "HttpMeta": {} - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/get_token_content.mdx b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/get_token_content.mdx index 5cfe6a8..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/plex/get_token/get_token_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/plex/get_token/get_token_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Plex* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/resources_content.mdx b/src/.gen/pages/01-reference/typescript/resources/resources_content.mdx index dc73216..992c54d 100644 --- a/src/.gen/pages/01-reference/typescript/resources/resources_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/resources_content.mdx @@ -13,7 +13,7 @@ import Library from "./library/library.mdx"; import Log from "./log/log.mdx"; import Plex from "./plex/plex.mdx"; import Playlists from "./playlists/playlists.mdx"; -import Security from "./security/security.mdx"; +import Authentication from "./authentication/authentication.mdx"; import Statistics from "./statistics/statistics.mdx"; import Sessions from "./sessions/sessions.mdx"; import Updater from "./updater/updater.mdx"; @@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx"; --- - + --- diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information_content.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/get_source_connection_information_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_header.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_header.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_response.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_response.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token_content.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/get_transient_token_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/security/security.mdx b/src/.gen/pages/01-reference/typescript/resources/security/security.mdx deleted file mode 100644 index 6c9b57d..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/security.mdx +++ /dev/null @@ -1,6 +0,0 @@ -import Security from './security_content.mdx'; -import {DocsSection} from "/src/components/Section/section"; - - - - diff --git a/src/.gen/pages/01-reference/typescript/resources/security/security_content.mdx b/src/.gen/pages/01-reference/typescript/resources/security/security_content.mdx deleted file mode 100644 index ec747fa..0000000 --- a/src/.gen/pages/01-reference/typescript/resources/security/security_content.mdx +++ /dev/null @@ -1 +0,0 @@ -null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx index c9ff431..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_header.mdx @@ -1,3 +1 @@ -## Get Statistics - -This will return the media statistics for the server \ No newline at end of file +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx index 5e7431e..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_parameters.mdx @@ -1,14 +1 @@ -{/* Autogenerated DO NOT EDIT */} -##### `timespan?`: *{`number`}* -The timespan to retrieve statistics for -the exact meaning of this parameter is not known - - ---- -##### `options?`: *{`RequestOptions`}* -Options for making HTTP requests. - ---- -##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) -Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx index 4706590..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_response.mdx @@ -1,13 +1 @@ -{/* Autogenerated DO NOT EDIT */} -import GetStatisticsResponse from "/content/types/models/operations/get_statistics_response/typescript.mdx" -import Collapsible from "/src/components/Collapsible"; -import Labels from "/src/lib/labels"; - -##### *{`Promise`}* - - - - - - - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx index 36dbc83..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/_usage.mdx @@ -1,33 +1 @@ - - -```typescript GetStatistics.ts -import { PlexAPI } from "@lukehagar/plexjs"; - -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const timespan = 944669; - - const result = await sdk.statistics.getStatistics(timespan); - - // Handle the result - console.log(result) -} - -run(); -``` ---- - -```json Example Response - { - "MediaContainer": { - "size": 5497, - "Device": [], - "Account": [], - "StatisticsMedia": [] - } - } -``` - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics_content.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics_content.mdx index 723ef2d..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/get_statistics/get_statistics_content.mdx @@ -1,21 +1 @@ -import CurlHeader from './_header.mdx'; -import SDKHeader from './_header.mdx'; -import OperationHeader from '/src/components/OperationHeader'; - -###### *Statistics* - -} - curlHeader={} -/> - -{/* rendered from operation template */} - -import {LanguageOperation} from "/content/languages"; -import Parameters from "./_parameters.mdx"; -import Response from "./_response.mdx"; -import Usage from "./_usage.mdx"; - -} response={} usage={}/> - -{/* end rendered section */} +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/resources/statistics/statistics_content.mdx b/src/.gen/pages/01-reference/typescript/resources/statistics/statistics_content.mdx index b75b178..ec747fa 100644 --- a/src/.gen/pages/01-reference/typescript/resources/statistics/statistics_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/statistics/statistics_content.mdx @@ -1,12 +1 @@ -import GetStatistics from "./get_statistics/get_statistics.mdx"; - -## Statistics -API Calls that perform operations with Plex Media Server Statistics - - -### Available Operations - -* [Get Statistics](/typescript/statistics/get_statistics) - Get Media Statistics - ---- - +null \ No newline at end of file diff --git a/src/.gen/pages/01-reference/typescript/security_options/_snippet.mdx b/src/.gen/pages/01-reference/typescript/security_options/_snippet.mdx index d9b99ef..d81faaa 100644 --- a/src/.gen/pages/01-reference/typescript/security_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/typescript/security_options/_snippet.mdx @@ -9,12 +9,13 @@ To authenticate with the API the `accessToken` parameter must be set when initia ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); +const plexAPI = new PlexAPI({ + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); diff --git a/src/.gen/pages/01-reference/typescript/server_options/_snippet.mdx b/src/.gen/pages/01-reference/typescript/server_options/_snippet.mdx index 04d0bcf..49601af 100644 --- a/src/.gen/pages/01-reference/typescript/server_options/_snippet.mdx +++ b/src/.gen/pages/01-reference/typescript/server_options/_snippet.mdx @@ -10,13 +10,14 @@ You can override the default server globally by passing a server index to the `s ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - serverIdx: 0, - accessToken: "", - }); +const plexAPI = new PlexAPI({ + serverIdx: 0, + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); @@ -40,13 +41,14 @@ The default server can also be overridden globally by passing a URL to the `serv ```typescript import { PlexAPI } from "@lukehagar/plexjs"; -async function run() { - const sdk = new PlexAPI({ - serverURL: "{protocol}://{ip}:{port}", - accessToken: "", - }); +const plexAPI = new PlexAPI({ + serverURL: "{protocol}://{ip}:{port}", + accessToken: "", + xPlexClientIdentifier: "Postman", +}); - const result = await sdk.server.getServerCapabilities(); +async function run() { + const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); @@ -62,15 +64,12 @@ The server URL can also be overridden on a per-operation basis, provided a serve ```typescript import { PlexAPI } from "@lukehagar/plexjs"; +const plexAPI = new PlexAPI({ + xPlexClientIdentifier: "Postman", +}); + async function run() { - const sdk = new PlexAPI({ - accessToken: "", - }); - - const xPlexClientIdentifier = ""; - const strong = false; - - const result = await sdk.plex.getPin(xPlexClientIdentifier, strong, { + const result = await plexAPI.plex.getPin(false, "Postman", { serverURL: "https://plex.tv/api/v2", }); diff --git a/src/.gen/pages/01-reference/typescript/typescript_content.mdx b/src/.gen/pages/01-reference/typescript/typescript_content.mdx index b133698..a55934b 100644 --- a/src/.gen/pages/01-reference/typescript/typescript_content.mdx +++ b/src/.gen/pages/01-reference/typescript/typescript_content.mdx @@ -6,6 +6,7 @@ import ClientSDKs from "./client_sdks/client_sdks.mdx"; import Installation from "./installation/installation.mdx"; import CustomClient from "./custom_http_client/custom_http_client.mdx"; import SecurityOptions from "./security_options/security_options.mdx"; +import Globals from "./global_parameters/global_parameters.mdx"; import Errors from "./errors/errors.mdx"; import ServerOptions from "./server_options/server_options.mdx"; import Resources from "./resources/resources.mdx"; @@ -29,6 +30,10 @@ import Resources from "./resources/resources.mdx"; --- + + +--- + --- diff --git a/src/pages/curl/_meta.json b/src/pages/curl/_meta.json index ad67ebb..a0c7ee0 100644 --- a/src/pages/curl/_meta.json +++ b/src/pages/curl/_meta.json @@ -8,9 +8,7 @@ "title": "Resources", "type": "separator" }, - "server": "Server", "media": "Media", - "video": "Video", "activities": "Activities", "butler": "Butler", "hubs": "Hubs", @@ -19,7 +17,10 @@ "log": "Log", "plex": "Plex", "playlists": "Playlists", + "authentication": "Authentication", "security": "Security", + "server": "Server", + "video": "Video", "statistics": "Statistics", "sessions": "Sessions", "updater": "Updater" diff --git a/src/pages/python/security/_meta.json b/src/pages/curl/authentication/_meta.json similarity index 53% rename from src/pages/python/security/_meta.json rename to src/pages/curl/authentication/_meta.json index 6922f6d..da4fbba 100644 --- a/src/pages/python/security/_meta.json +++ b/src/pages/curl/authentication/_meta.json @@ -1,4 +1,4 @@ { - "get_source_connection_information": "Get Source Connection Information", - "get_transient_token": "Get Transient Token" + "get_transient_token": "Get Transient Token", + "get_source_connection_information": "Get Source Connection Information" } \ No newline at end of file diff --git a/src/pages/curl/plex/tv/get_pin/_meta.json b/src/pages/curl/authentication/get_source_connection_information/_meta.json similarity index 100% rename from src/pages/curl/plex/tv/get_pin/_meta.json rename to src/pages/curl/authentication/get_source_connection_information/_meta.json diff --git a/src/pages/curl/plex/tv/get_token/_meta.json b/src/pages/curl/authentication/get_transient_token/_meta.json similarity index 100% rename from src/pages/curl/plex/tv/get_token/_meta.json rename to src/pages/curl/authentication/get_transient_token/_meta.json diff --git a/src/pages/curl/plex/_meta.json b/src/pages/curl/plex/_meta.json index 6c7cfc3..e8b6d62 100644 --- a/src/pages/curl/plex/_meta.json +++ b/src/pages/curl/plex/_meta.json @@ -1,5 +1,4 @@ { "get_pin": "Get Pin", - "get_token": "Get Token", - "tv": "Tv" + "get_token": "Get Token" } \ No newline at end of file diff --git a/src/pages/curl/plex/tv/_meta.json b/src/pages/curl/plex/tv/_meta.json deleted file mode 100644 index e8b6d62..0000000 --- a/src/pages/curl/plex/tv/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "get_pin": "Get Pin", - "get_token": "Get Token" -} \ No newline at end of file diff --git a/src/pages/curl/security/_meta.json b/src/pages/curl/security/_meta.json index da4fbba..6922f6d 100644 --- a/src/pages/curl/security/_meta.json +++ b/src/pages/curl/security/_meta.json @@ -1,4 +1,4 @@ { - "get_transient_token": "Get Transient Token", - "get_source_connection_information": "Get Source Connection Information" + "get_source_connection_information": "Get Source Connection Information", + "get_transient_token": "Get Transient Token" } \ No newline at end of file diff --git a/src/pages/go/_meta.json b/src/pages/go/_meta.json index 8b64645..6ae9ca2 100644 --- a/src/pages/go/_meta.json +++ b/src/pages/go/_meta.json @@ -7,6 +7,7 @@ "installation": "Installation", "custom_http_client": "Custom Http Client", "security_options": "Security Options", + "global_parameters": "Global Parameters", "errors": "Errors", "server_options": "Server Options", "-- resources": { @@ -24,7 +25,7 @@ "log": "Log", "plex": "Plex", "playlists": "Playlists", - "security": "Security", + "authentication": "Authentication", "statistics": "Statistics", "sessions": "Sessions", "updater": "Updater" diff --git a/src/pages/typescript/security/_meta.json b/src/pages/go/authentication/_meta.json similarity index 53% rename from src/pages/typescript/security/_meta.json rename to src/pages/go/authentication/_meta.json index 6922f6d..da4fbba 100644 --- a/src/pages/typescript/security/_meta.json +++ b/src/pages/go/authentication/_meta.json @@ -1,4 +1,4 @@ { - "get_source_connection_information": "Get Source Connection Information", - "get_transient_token": "Get Transient Token" + "get_transient_token": "Get Transient Token", + "get_source_connection_information": "Get Source Connection Information" } \ No newline at end of file diff --git a/src/pages/go/plex/tv/get_pin/_meta.json b/src/pages/go/authentication/get_source_connection_information/_meta.json similarity index 100% rename from src/pages/go/plex/tv/get_pin/_meta.json rename to src/pages/go/authentication/get_source_connection_information/_meta.json diff --git a/src/pages/go/plex/tv/get_token/_meta.json b/src/pages/go/authentication/get_transient_token/_meta.json similarity index 100% rename from src/pages/go/plex/tv/get_token/_meta.json rename to src/pages/go/authentication/get_transient_token/_meta.json diff --git a/src/pages/go/security/get_source_connection_information/_meta.json b/src/pages/go/global_parameters/_meta.json similarity index 100% rename from src/pages/go/security/get_source_connection_information/_meta.json rename to src/pages/go/global_parameters/_meta.json diff --git a/src/pages/go/plex/_meta.json b/src/pages/go/plex/_meta.json index 6c7cfc3..e8b6d62 100644 --- a/src/pages/go/plex/_meta.json +++ b/src/pages/go/plex/_meta.json @@ -1,5 +1,4 @@ { "get_pin": "Get Pin", - "get_token": "Get Token", - "tv": "Tv" + "get_token": "Get Token" } \ No newline at end of file diff --git a/src/pages/go/plex/tv/_meta.json b/src/pages/go/plex/tv/_meta.json deleted file mode 100644 index e8b6d62..0000000 --- a/src/pages/go/plex/tv/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "get_pin": "Get Pin", - "get_token": "Get Token" -} \ No newline at end of file diff --git a/src/pages/python/_meta.json b/src/pages/python/_meta.json index 8b64645..6ae9ca2 100644 --- a/src/pages/python/_meta.json +++ b/src/pages/python/_meta.json @@ -7,6 +7,7 @@ "installation": "Installation", "custom_http_client": "Custom Http Client", "security_options": "Security Options", + "global_parameters": "Global Parameters", "errors": "Errors", "server_options": "Server Options", "-- resources": { @@ -24,7 +25,7 @@ "log": "Log", "plex": "Plex", "playlists": "Playlists", - "security": "Security", + "authentication": "Authentication", "statistics": "Statistics", "sessions": "Sessions", "updater": "Updater" diff --git a/src/pages/go/security/_meta.json b/src/pages/python/authentication/_meta.json similarity index 53% rename from src/pages/go/security/_meta.json rename to src/pages/python/authentication/_meta.json index 6922f6d..da4fbba 100644 --- a/src/pages/go/security/_meta.json +++ b/src/pages/python/authentication/_meta.json @@ -1,4 +1,4 @@ { - "get_source_connection_information": "Get Source Connection Information", - "get_transient_token": "Get Transient Token" + "get_transient_token": "Get Transient Token", + "get_source_connection_information": "Get Source Connection Information" } \ No newline at end of file diff --git a/src/pages/go/security/get_transient_token/_meta.json b/src/pages/python/authentication/get_source_connection_information/_meta.json similarity index 100% rename from src/pages/go/security/get_transient_token/_meta.json rename to src/pages/python/authentication/get_source_connection_information/_meta.json diff --git a/src/pages/python/plex/tv/get_pin/_meta.json b/src/pages/python/authentication/get_transient_token/_meta.json similarity index 100% rename from src/pages/python/plex/tv/get_pin/_meta.json rename to src/pages/python/authentication/get_transient_token/_meta.json diff --git a/src/pages/python/plex/tv/get_token/_meta.json b/src/pages/python/global_parameters/_meta.json similarity index 100% rename from src/pages/python/plex/tv/get_token/_meta.json rename to src/pages/python/global_parameters/_meta.json diff --git a/src/pages/python/plex/_meta.json b/src/pages/python/plex/_meta.json index 6c7cfc3..e8b6d62 100644 --- a/src/pages/python/plex/_meta.json +++ b/src/pages/python/plex/_meta.json @@ -1,5 +1,4 @@ { "get_pin": "Get Pin", - "get_token": "Get Token", - "tv": "Tv" + "get_token": "Get Token" } \ No newline at end of file diff --git a/src/pages/python/plex/tv/_meta.json b/src/pages/python/plex/tv/_meta.json deleted file mode 100644 index e8b6d62..0000000 --- a/src/pages/python/plex/tv/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "get_pin": "Get Pin", - "get_token": "Get Token" -} \ No newline at end of file diff --git a/src/pages/typescript/_meta.json b/src/pages/typescript/_meta.json index 8b64645..6ae9ca2 100644 --- a/src/pages/typescript/_meta.json +++ b/src/pages/typescript/_meta.json @@ -7,6 +7,7 @@ "installation": "Installation", "custom_http_client": "Custom Http Client", "security_options": "Security Options", + "global_parameters": "Global Parameters", "errors": "Errors", "server_options": "Server Options", "-- resources": { @@ -24,7 +25,7 @@ "log": "Log", "plex": "Plex", "playlists": "Playlists", - "security": "Security", + "authentication": "Authentication", "statistics": "Statistics", "sessions": "Sessions", "updater": "Updater" diff --git a/src/pages/typescript/authentication/_meta.json b/src/pages/typescript/authentication/_meta.json new file mode 100644 index 0000000..da4fbba --- /dev/null +++ b/src/pages/typescript/authentication/_meta.json @@ -0,0 +1,4 @@ +{ + "get_transient_token": "Get Transient Token", + "get_source_connection_information": "Get Source Connection Information" +} \ No newline at end of file diff --git a/src/pages/python/security/get_source_connection_information/_meta.json b/src/pages/typescript/authentication/get_source_connection_information/_meta.json similarity index 100% rename from src/pages/python/security/get_source_connection_information/_meta.json rename to src/pages/typescript/authentication/get_source_connection_information/_meta.json diff --git a/src/pages/python/security/get_transient_token/_meta.json b/src/pages/typescript/authentication/get_transient_token/_meta.json similarity index 100% rename from src/pages/python/security/get_transient_token/_meta.json rename to src/pages/typescript/authentication/get_transient_token/_meta.json diff --git a/src/pages/typescript/plex/tv/get_pin/_meta.json b/src/pages/typescript/global_parameters/_meta.json similarity index 100% rename from src/pages/typescript/plex/tv/get_pin/_meta.json rename to src/pages/typescript/global_parameters/_meta.json diff --git a/src/pages/typescript/plex/_meta.json b/src/pages/typescript/plex/_meta.json index 6c7cfc3..e8b6d62 100644 --- a/src/pages/typescript/plex/_meta.json +++ b/src/pages/typescript/plex/_meta.json @@ -1,5 +1,4 @@ { "get_pin": "Get Pin", - "get_token": "Get Token", - "tv": "Tv" + "get_token": "Get Token" } \ No newline at end of file diff --git a/src/pages/typescript/plex/tv/_meta.json b/src/pages/typescript/plex/tv/_meta.json deleted file mode 100644 index e8b6d62..0000000 --- a/src/pages/typescript/plex/tv/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "get_pin": "Get Pin", - "get_token": "Get Token" -} \ No newline at end of file diff --git a/src/pages/typescript/plex/tv/get_token/_meta.json b/src/pages/typescript/plex/tv/get_token/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/typescript/plex/tv/get_token/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/typescript/security/get_source_connection_information/_meta.json b/src/pages/typescript/security/get_source_connection_information/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/typescript/security/get_source_connection_information/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/typescript/security/get_transient_token/_meta.json b/src/pages/typescript/security/get_transient_token/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/typescript/security/get_transient_token/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file