mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.277.4
This commit is contained in:
speakeasybot
@@ -1,27 +1,29 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 7fc33f51-d778-40ef-b094-90972c025d39
|
||||
management:
|
||||
docChecksum: 278d186496d83d5830ba4870f8cad39d
|
||||
docChecksum: 7a43cd3413d535205cfaee20a4b6a250
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: internal
|
||||
generationVersion: 2.269.0
|
||||
releaseVersion: 0.4.0
|
||||
configChecksum: 36a0bdf87b71fb5e9239da9afe59ff45
|
||||
generationVersion: 2.318.3
|
||||
releaseVersion: 0.5.0
|
||||
configChecksum: 236cadbf0cc75d00a7178e8571d80a83
|
||||
published: true
|
||||
features:
|
||||
docs:
|
||||
constsAndDefaults: 0.1.0
|
||||
core: 1.26.2
|
||||
constsAndDefaults: 0.1.1
|
||||
core: 1.26.3
|
||||
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
|
||||
@@ -2492,19 +2498,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
|
||||
@@ -3080,6 +3086,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 +3106,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 +3364,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 +3495,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 +3546,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 +3585,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 +3605,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 +3863,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 +3994,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 +4045,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 +4084,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 +4104,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 +4362,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 +4493,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 +4544,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 +4593,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 +4891,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 +5035,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 +5079,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
|
||||
|
||||
@@ -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
|
||||
- Speakeasy CLI 1.193.0 (2.269.0) https://github.com/speakeasy-api/speakeasy
|
||||
|
||||
## 2024-05-01 00:31:52
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc 0.0.3
|
||||
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
|
||||
---
|
||||
<GetSourceConnectionInformation />
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Security*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Security*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -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)
|
||||
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
|
||||
@@ -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: <value>'
|
||||
--header 'X-Plex-Client-Identifier: Postman'
|
||||
```
|
||||
---
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
```bash Example Request
|
||||
curl https://plex.tv/api/v2/pins/<value> \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
|
||||
--header 'X-Plex-Client-Identifier: <value>'
|
||||
--header 'X-Plex-Client-Identifier: Postman'
|
||||
```
|
||||
---
|
||||
|
||||
|
||||
@@ -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";
|
||||
<Playlists/>
|
||||
|
||||
---
|
||||
<Security/>
|
||||
<Authentication/>
|
||||
|
||||
---
|
||||
<Statistics/>
|
||||
|
||||
@@ -20,6 +20,7 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
|
||||
38
content/pages/01-reference/go/global_parameters/_snippet.mdx
Normal file
38
content/pages/01-reference/go/global_parameters/_snippet.mdx
Normal file
@@ -0,0 +1,38 @@
|
||||
{/* 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 */}
|
||||
@@ -0,0 +1,6 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Global Parameters <LanguageSelector/></H2>
|
||||
|
||||
{/* render global_parameters */}
|
||||
@@ -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";
|
||||
|
||||
---
|
||||
|
||||
<Globals/>
|
||||
|
||||
---
|
||||
|
||||
<Errors/>
|
||||
|
||||
---
|
||||
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
<br/>
|
||||
**Example:** `server://client-identifier`
|
||||
|
||||
@@ -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`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetSourceConnectionInformationResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
---
|
||||
##### *{`error`}*
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetToken.go
|
||||
```go GetSourceConnectionInformation.go
|
||||
package main
|
||||
|
||||
import(
|
||||
@@ -8,26 +8,23 @@ import(
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"context"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
|
||||
var pinID string = "<value>"
|
||||
|
||||
var xPlexClientIdentifier string = "<value>"
|
||||
var source string = "server://client-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 +35,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": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
##### `scope` *{`operations.Scope`}*
|
||||
`all` \- This is the only supported `scope` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Scope />
|
||||
</Collapsible>
|
||||
|
||||
@@ -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`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
<GetTransientTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
|
||||
<CH.Code>
|
||||
```go GetTransientToken.go
|
||||
package main
|
||||
|
||||
import(
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"context"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
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": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -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.
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```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("<YOUR_API_KEY_HERE>"),
|
||||
)
|
||||
|
||||
|
||||
var xPlexClientIdentifier string = "<value>"
|
||||
|
||||
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"
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -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.
|
||||
|
||||
@@ -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";
|
||||
<Playlists/>
|
||||
|
||||
---
|
||||
<Security/>
|
||||
<Authentication/>
|
||||
|
||||
---
|
||||
<Statistics/>
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Statistics
|
||||
|
||||
This will return the media statistics for the server
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Statistics*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetStatistics />
|
||||
@@ -18,6 +18,7 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -25,7 +26,6 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerIndex(0),
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -29,7 +30,6 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
@@ -61,6 +61,7 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -68,7 +69,6 @@ func main() {
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
@@ -85,25 +85,23 @@ package main
|
||||
import (
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/components"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithXPlexClientIdentifier("Postman"),
|
||||
)
|
||||
|
||||
var xPlexClientIdentifier string = "<value>"
|
||||
|
||||
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, operations.WithServerURL("https://plex.tv/api/v2"), strong, xPlexClientIdentifier)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if res.Object != nil {
|
||||
// handle response
|
||||
}
|
||||
|
||||
@@ -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 */}
|
||||
|
||||
@@ -11,6 +11,7 @@ from plex_api.models import errors
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
)
|
||||
|
||||
|
||||
@@ -27,6 +28,7 @@ except errors.SDKError as e:
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
|
||||
{/* End Python Errors */}
|
||||
|
||||
@@ -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 */}
|
||||
@@ -0,0 +1,6 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Global Parameters <LanguageSelector/></H2>
|
||||
|
||||
{/* render global_parameters */}
|
||||
@@ -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";
|
||||
|
||||
---
|
||||
|
||||
<Globals/>
|
||||
|
||||
---
|
||||
|
||||
<Errors/>
|
||||
|
||||
---
|
||||
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
|
||||
---
|
||||
<GetSourceConnectionInformation />
|
||||
@@ -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.
|
||||
@@ -0,0 +1,6 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `source` *{`str`}*
|
||||
The source identifier with an included prefix.
|
||||
<br/>
|
||||
**Example:** `server://client-identifier`
|
||||
|
||||
@@ -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`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetSourceConnectionInformationResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetSourceConnectionInformation.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
)
|
||||
|
||||
|
||||
res = s.authentication.get_source_connection_information(source='server://client-identifier')
|
||||
|
||||
if res is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
],
|
||||
"HttpMeta": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
##### `scope` *{`operations.Scope`}*
|
||||
`all` \- This is the only supported `scope` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Scope />
|
||||
</Collapsible>
|
||||
|
||||
@@ -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`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTokenResponse />
|
||||
<GetTransientTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetTransientToken.py
|
||||
import plex_api
|
||||
from plex_api.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
)
|
||||
|
||||
|
||||
res = s.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": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -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.
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetPin.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.get_pin(x_plex_client_identifier='<value>', 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"
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -1,15 +0,0 @@
|
||||
{/* 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.
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetToken.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='<value>')
|
||||
|
||||
if res.status_code == 200:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1000,
|
||||
"message": "X-Plex-Client-Identifier is missing",
|
||||
"status": 400
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -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";
|
||||
<Playlists/>
|
||||
|
||||
---
|
||||
<Security/>
|
||||
<Authentication/>
|
||||
|
||||
---
|
||||
<Statistics/>
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Statistics
|
||||
|
||||
This will return the media statistics for the server
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetStatisticsResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```python GetStatistics.py
|
||||
import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
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": []
|
||||
}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Statistics*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetStatistics />
|
||||
@@ -11,6 +11,7 @@ import plex_api
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
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 */}
|
||||
|
||||
@@ -14,6 +14,7 @@ import plex_api
|
||||
s = plex_api.PlexAPI(
|
||||
server_idx=0,
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
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="<YOUR_API_KEY_HERE>",
|
||||
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="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
)
|
||||
|
||||
|
||||
res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='<value>', strong=False)
|
||||
res = s.plex.get_pin(server_url="https://plex.tv/api/v2", strong=False, x_plex_client_identifier='Postman')
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
{/* End Python Server Options */}
|
||||
|
||||
@@ -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: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
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;
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
{/* 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 strong = false;
|
||||
const xPlexClientIdentifier = "Postman";
|
||||
|
||||
const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
{/* End Typescript Global Parameters */}
|
||||
@@ -0,0 +1,6 @@
|
||||
import LanguageSelector from 'src/components/LanguageSelector';
|
||||
import { H2 } from "src/components/TextHeaderWrapper";
|
||||
|
||||
<H2>Global Parameters <LanguageSelector/></H2>
|
||||
|
||||
{/* render global_parameters */}
|
||||
@@ -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
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
|
||||
---
|
||||
<GetSourceConnectionInformation />
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
<br/>
|
||||
**Example:** `[object Object]`
|
||||
|
||||
---
|
||||
##### `options?`: *{`RequestOptions`}*
|
||||
@@ -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<operations.GetSourceConnectionInformationResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetSourceConnectionInformationResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript GetSourceConnectionInformation.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const source = "server://client-identifier";
|
||||
|
||||
const result = await plexAPI.authentication.getSourceConnectionInformation(source);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
],
|
||||
"HttpMeta": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTransientTokenQueryParamType />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
##### `scope`: *{`operations.Scope`}*
|
||||
`all` \- This is the only supported `scope` parameter.
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Scope />
|
||||
</Collapsible>
|
||||
|
||||
---
|
||||
##### `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.
|
||||
|
||||
@@ -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/typescript.mdx"
|
||||
import Collapsible from "/src/components/Collapsible";
|
||||
import Labels from "/src/lib/labels";
|
||||
|
||||
##### *{`operations.GetPinResponse`}*
|
||||
##### *{`Promise<operations.GetTransientTokenResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
<GetTransientTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript GetTransientToken.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
xPlexClientIdentifier: "Postman",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const type = GetTransientTokenQueryParamType.Delegation;
|
||||
const scope = Scope.All;
|
||||
|
||||
const result = await plexAPI.authentication.getTransientToken(type, scope);
|
||||
|
||||
// Handle the result
|
||||
console.log(result)
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
---
|
||||
|
||||
```json Example Response
|
||||
{
|
||||
"errors": [
|
||||
{
|
||||
"code": 1001,
|
||||
"message": "User could not be authenticated",
|
||||
"status": 401
|
||||
}
|
||||
],
|
||||
"HttpMeta": {}
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -0,0 +1,12 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Pin
|
||||
|
||||
Retrieve a Pin from Plex.tv for authentication flows
|
||||
@@ -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.
|
||||
|
||||
@@ -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<operations.GetPinResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetPinResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
|
||||
<CH.Code>
|
||||
```typescript GetPin.ts
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
async function run() {
|
||||
const sdk = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
const xPlexClientIdentifier = "<value>";
|
||||
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"
|
||||
}
|
||||
```
|
||||
</CH.Code>
|
||||
@@ -1,12 +0,0 @@
|
||||
import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Plex*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
curlHeader={<CurlHeader />}
|
||||
/>
|
||||
|
||||
{/* render operation */}
|
||||
@@ -1,3 +0,0 @@
|
||||
## Get Token
|
||||
|
||||
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||
@@ -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<operations.GetTokenResponse>`}*
|
||||
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<GetTokenResponse />
|
||||
</Collapsible>
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user