ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.161.0

This commit is contained in:
speakeasybot
2024-02-01 00:31:41 +00:00
parent 64a942a910
commit bbed03f967
208 changed files with 3319 additions and 46 deletions

View File

@@ -1,20 +1,21 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: 7fc33f51-d778-40ef-b094-90972c025d39 id: 7fc33f51-d778-40ef-b094-90972c025d39
management: management:
docChecksum: 95d4ac4070b7f9db42126fc81b258e02 docChecksum: 94439465ae5d544f0e52b00719af05ee
docVersion: 0.0.3 docVersion: 0.0.3
speakeasyVersion: internal speakeasyVersion: internal
generationVersion: 2.239.0 generationVersion: 2.245.1
releaseVersion: 0.2.1 releaseVersion: 0.3.0
configChecksum: 5421929b3e489a66ede916e408575cf8 configChecksum: 263b58c1fc894b4f65ef4ffd5a694be3
published: true published: true
features: features:
docs: docs:
constsAndDefaults: 0.1.0 constsAndDefaults: 0.1.0
core: 1.24.2 core: 1.25.0
flattening: 0.1.0 flattening: 0.1.0
globalSecurity: 0.1.1 globalSecurity: 0.1.1
globalServerURLs: 0.1.1 globalServerURLs: 0.1.1
methodServerURLs: 0.1.1
nameOverrides: 0.1.0 nameOverrides: 0.1.0
unions: 0.1.2 unions: 0.1.2
generatedFiles: generatedFiles:
@@ -205,6 +206,18 @@ generatedFiles:
- content/pages/01-reference/go/resources/playlists/upload_playlist/_response.mdx - content/pages/01-reference/go/resources/playlists/upload_playlist/_response.mdx
- content/pages/01-reference/go/resources/playlists/upload_playlist/_usage.mdx - content/pages/01-reference/go/resources/playlists/upload_playlist/_usage.mdx
- content/pages/01-reference/go/resources/playlists/upload_playlist/upload_playlist.mdx - content/pages/01-reference/go/resources/playlists/upload_playlist/upload_playlist.mdx
- content/pages/01-reference/go/resources/plex/plex.mdx
- content/pages/01-reference/go/resources/plex/tv/get_pin/_header.mdx
- content/pages/01-reference/go/resources/plex/tv/get_pin/_parameters.mdx
- content/pages/01-reference/go/resources/plex/tv/get_pin/_response.mdx
- content/pages/01-reference/go/resources/plex/tv/get_pin/_usage.mdx
- content/pages/01-reference/go/resources/plex/tv/get_pin/get_pin.mdx
- content/pages/01-reference/go/resources/plex/tv/get_token/_header.mdx
- content/pages/01-reference/go/resources/plex/tv/get_token/_parameters.mdx
- content/pages/01-reference/go/resources/plex/tv/get_token/_response.mdx
- content/pages/01-reference/go/resources/plex/tv/get_token/_usage.mdx
- content/pages/01-reference/go/resources/plex/tv/get_token/get_token.mdx
- content/pages/01-reference/go/resources/plex/tv/tv.mdx
- content/pages/01-reference/go/resources/search/get_search_results/_header.mdx - content/pages/01-reference/go/resources/search/get_search_results/_header.mdx
- content/pages/01-reference/go/resources/search/get_search_results/_parameters.mdx - content/pages/01-reference/go/resources/search/get_search_results/_parameters.mdx
- content/pages/01-reference/go/resources/search/get_search_results/_response.mdx - content/pages/01-reference/go/resources/search/get_search_results/_response.mdx
@@ -510,6 +523,18 @@ generatedFiles:
- content/pages/01-reference/python/resources/playlists/upload_playlist/_response.mdx - content/pages/01-reference/python/resources/playlists/upload_playlist/_response.mdx
- content/pages/01-reference/python/resources/playlists/upload_playlist/_usage.mdx - content/pages/01-reference/python/resources/playlists/upload_playlist/_usage.mdx
- content/pages/01-reference/python/resources/playlists/upload_playlist/upload_playlist.mdx - content/pages/01-reference/python/resources/playlists/upload_playlist/upload_playlist.mdx
- content/pages/01-reference/python/resources/plex/plex.mdx
- content/pages/01-reference/python/resources/plex/tv/get_pin/_header.mdx
- content/pages/01-reference/python/resources/plex/tv/get_pin/_parameters.mdx
- content/pages/01-reference/python/resources/plex/tv/get_pin/_response.mdx
- content/pages/01-reference/python/resources/plex/tv/get_pin/_usage.mdx
- content/pages/01-reference/python/resources/plex/tv/get_pin/get_pin.mdx
- content/pages/01-reference/python/resources/plex/tv/get_token/_header.mdx
- content/pages/01-reference/python/resources/plex/tv/get_token/_parameters.mdx
- content/pages/01-reference/python/resources/plex/tv/get_token/_response.mdx
- content/pages/01-reference/python/resources/plex/tv/get_token/_usage.mdx
- content/pages/01-reference/python/resources/plex/tv/get_token/get_token.mdx
- content/pages/01-reference/python/resources/plex/tv/tv.mdx
- content/pages/01-reference/python/resources/search/get_search_results/_header.mdx - content/pages/01-reference/python/resources/search/get_search_results/_header.mdx
- content/pages/01-reference/python/resources/search/get_search_results/_parameters.mdx - content/pages/01-reference/python/resources/search/get_search_results/_parameters.mdx
- content/pages/01-reference/python/resources/search/get_search_results/_response.mdx - content/pages/01-reference/python/resources/search/get_search_results/_response.mdx
@@ -815,6 +840,18 @@ generatedFiles:
- content/pages/01-reference/typescript/resources/playlists/upload_playlist/_response.mdx - content/pages/01-reference/typescript/resources/playlists/upload_playlist/_response.mdx
- content/pages/01-reference/typescript/resources/playlists/upload_playlist/_usage.mdx - content/pages/01-reference/typescript/resources/playlists/upload_playlist/_usage.mdx
- content/pages/01-reference/typescript/resources/playlists/upload_playlist/upload_playlist.mdx - content/pages/01-reference/typescript/resources/playlists/upload_playlist/upload_playlist.mdx
- content/pages/01-reference/typescript/resources/plex/plex.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_pin/_header.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_pin/_parameters.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_pin/_response.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_pin/_usage.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_pin/get_pin.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_token/_header.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_token/_parameters.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_token/_response.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_token/_usage.mdx
- content/pages/01-reference/typescript/resources/plex/tv/get_token/get_token.mdx
- content/pages/01-reference/typescript/resources/plex/tv/tv.mdx
- content/pages/01-reference/typescript/resources/search/get_search_results/_header.mdx - content/pages/01-reference/typescript/resources/search/get_search_results/_header.mdx
- content/pages/01-reference/typescript/resources/search/get_search_results/_parameters.mdx - content/pages/01-reference/typescript/resources/search/get_search_results/_parameters.mdx
- content/pages/01-reference/typescript/resources/search/get_search_results/_response.mdx - content/pages/01-reference/typescript/resources/search/get_search_results/_response.mdx
@@ -1022,6 +1059,10 @@ generatedFiles:
- content/types/models/errors/get_on_deck_errors/typescript.mdx - content/types/models/errors/get_on_deck_errors/typescript.mdx
- content/types/models/errors/get_on_deck_response_body/python.mdx - content/types/models/errors/get_on_deck_response_body/python.mdx
- content/types/models/errors/get_on_deck_response_body/typescript.mdx - content/types/models/errors/get_on_deck_response_body/typescript.mdx
- content/types/models/errors/get_pin_errors/python.mdx
- content/types/models/errors/get_pin_errors/typescript.mdx
- content/types/models/errors/get_pin_response_body/python.mdx
- content/types/models/errors/get_pin_response_body/typescript.mdx
- content/types/models/errors/get_playlist_contents_errors/python.mdx - content/types/models/errors/get_playlist_contents_errors/python.mdx
- content/types/models/errors/get_playlist_contents_errors/typescript.mdx - content/types/models/errors/get_playlist_contents_errors/typescript.mdx
- content/types/models/errors/get_playlist_contents_response_body/python.mdx - content/types/models/errors/get_playlist_contents_response_body/python.mdx
@@ -1080,6 +1121,10 @@ generatedFiles:
- content/types/models/errors/get_timeline_errors/typescript.mdx - content/types/models/errors/get_timeline_errors/typescript.mdx
- content/types/models/errors/get_timeline_response_body/python.mdx - content/types/models/errors/get_timeline_response_body/python.mdx
- content/types/models/errors/get_timeline_response_body/typescript.mdx - content/types/models/errors/get_timeline_response_body/typescript.mdx
- content/types/models/errors/get_token_errors/python.mdx
- content/types/models/errors/get_token_errors/typescript.mdx
- content/types/models/errors/get_token_response_body/python.mdx
- content/types/models/errors/get_token_response_body/typescript.mdx
- content/types/models/errors/get_transcode_sessions_errors/python.mdx - content/types/models/errors/get_transcode_sessions_errors/python.mdx
- content/types/models/errors/get_transcode_sessions_errors/typescript.mdx - content/types/models/errors/get_transcode_sessions_errors/typescript.mdx
- content/types/models/errors/get_transcode_sessions_response_body/python.mdx - content/types/models/errors/get_transcode_sessions_response_body/python.mdx
@@ -1315,6 +1360,9 @@ generatedFiles:
- content/types/models/operations/get_libraries_directory/go.mdx - content/types/models/operations/get_libraries_directory/go.mdx
- content/types/models/operations/get_libraries_directory/python.mdx - content/types/models/operations/get_libraries_directory/python.mdx
- content/types/models/operations/get_libraries_directory/typescript.mdx - content/types/models/operations/get_libraries_directory/typescript.mdx
- content/types/models/operations/get_libraries_location/go.mdx
- content/types/models/operations/get_libraries_location/python.mdx
- content/types/models/operations/get_libraries_location/typescript.mdx
- content/types/models/operations/get_libraries_media_container/go.mdx - content/types/models/operations/get_libraries_media_container/go.mdx
- content/types/models/operations/get_libraries_media_container/python.mdx - content/types/models/operations/get_libraries_media_container/python.mdx
- content/types/models/operations/get_libraries_media_container/typescript.mdx - content/types/models/operations/get_libraries_media_container/typescript.mdx
@@ -1501,6 +1549,15 @@ generatedFiles:
- content/types/models/operations/get_on_deck_stream/go.mdx - content/types/models/operations/get_on_deck_stream/go.mdx
- content/types/models/operations/get_on_deck_stream/python.mdx - content/types/models/operations/get_on_deck_stream/python.mdx
- content/types/models/operations/get_on_deck_stream/typescript.mdx - content/types/models/operations/get_on_deck_stream/typescript.mdx
- content/types/models/operations/get_pin_request/go.mdx
- content/types/models/operations/get_pin_request/python.mdx
- content/types/models/operations/get_pin_request/typescript.mdx
- content/types/models/operations/get_pin_response/go.mdx
- content/types/models/operations/get_pin_response/python.mdx
- content/types/models/operations/get_pin_response/typescript.mdx
- content/types/models/operations/get_pin_response_body/go.mdx
- content/types/models/operations/get_pin_response_body/python.mdx
- content/types/models/operations/get_pin_response_body/typescript.mdx
- content/types/models/operations/get_playlist_contents_country/go.mdx - content/types/models/operations/get_playlist_contents_country/go.mdx
- content/types/models/operations/get_playlist_contents_country/python.mdx - content/types/models/operations/get_playlist_contents_country/python.mdx
- content/types/models/operations/get_playlist_contents_country/typescript.mdx - content/types/models/operations/get_playlist_contents_country/typescript.mdx
@@ -1708,6 +1765,12 @@ generatedFiles:
- content/types/models/operations/get_timeline_response/go.mdx - content/types/models/operations/get_timeline_response/go.mdx
- content/types/models/operations/get_timeline_response/python.mdx - content/types/models/operations/get_timeline_response/python.mdx
- content/types/models/operations/get_timeline_response/typescript.mdx - content/types/models/operations/get_timeline_response/typescript.mdx
- content/types/models/operations/get_token_request/go.mdx
- content/types/models/operations/get_token_request/python.mdx
- content/types/models/operations/get_token_request/typescript.mdx
- content/types/models/operations/get_token_response/go.mdx
- content/types/models/operations/get_token_response/python.mdx
- content/types/models/operations/get_token_response/typescript.mdx
- content/types/models/operations/get_transcode_sessions_media_container/go.mdx - content/types/models/operations/get_transcode_sessions_media_container/go.mdx
- content/types/models/operations/get_transcode_sessions_media_container/python.mdx - content/types/models/operations/get_transcode_sessions_media_container/python.mdx
- content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx - content/types/models/operations/get_transcode_sessions_media_container/typescript.mdx
@@ -1938,7 +2001,7 @@ generatedFiles:
- content/types/models/operations/two/typescript.mdx - content/types/models/operations/two/typescript.mdx
- content/types/models/operations/type/go.mdx - content/types/models/operations/type/go.mdx
- content/types/models/operations/type/python.mdx - content/types/models/operations/type/python.mdx
- content/types/models/operations/type_t/typescript.mdx - content/types/models/operations/type/typescript.mdx
- content/types/models/operations/update_play_progress_request/go.mdx - content/types/models/operations/update_play_progress_request/go.mdx
- content/types/models/operations/update_play_progress_request/python.mdx - content/types/models/operations/update_play_progress_request/python.mdx
- content/types/models/operations/update_play_progress_request/typescript.mdx - content/types/models/operations/update_play_progress_request/typescript.mdx
@@ -2009,6 +2072,8 @@ generatedFiles:
- content/types/models/sdkerrors/get_my_plex_account_response_body/go.mdx - content/types/models/sdkerrors/get_my_plex_account_response_body/go.mdx
- content/types/models/sdkerrors/get_on_deck_errors/go.mdx - content/types/models/sdkerrors/get_on_deck_errors/go.mdx
- content/types/models/sdkerrors/get_on_deck_response_body/go.mdx - content/types/models/sdkerrors/get_on_deck_response_body/go.mdx
- content/types/models/sdkerrors/get_pin_errors/go.mdx
- content/types/models/sdkerrors/get_pin_response_body/go.mdx
- content/types/models/sdkerrors/get_playlist_contents_errors/go.mdx - content/types/models/sdkerrors/get_playlist_contents_errors/go.mdx
- content/types/models/sdkerrors/get_playlist_contents_response_body/go.mdx - content/types/models/sdkerrors/get_playlist_contents_response_body/go.mdx
- content/types/models/sdkerrors/get_playlist_errors/go.mdx - content/types/models/sdkerrors/get_playlist_errors/go.mdx
@@ -2038,6 +2103,8 @@ generatedFiles:
- content/types/models/sdkerrors/get_source_connection_information_response_body/go.mdx - content/types/models/sdkerrors/get_source_connection_information_response_body/go.mdx
- content/types/models/sdkerrors/get_timeline_errors/go.mdx - content/types/models/sdkerrors/get_timeline_errors/go.mdx
- content/types/models/sdkerrors/get_timeline_response_body/go.mdx - content/types/models/sdkerrors/get_timeline_response_body/go.mdx
- content/types/models/sdkerrors/get_token_errors/go.mdx
- content/types/models/sdkerrors/get_token_response_body/go.mdx
- content/types/models/sdkerrors/get_transcode_sessions_errors/go.mdx - content/types/models/sdkerrors/get_transcode_sessions_errors/go.mdx
- content/types/models/sdkerrors/get_transcode_sessions_response_body/go.mdx - content/types/models/sdkerrors/get_transcode_sessions_response_body/go.mdx
- content/types/models/sdkerrors/get_transient_token_errors/go.mdx - content/types/models/sdkerrors/get_transient_token_errors/go.mdx
@@ -2308,6 +2375,20 @@ generatedFiles:
- content/pages/01-reference/curl/resources/log/enable_paper_trail/_parameters.mdx - content/pages/01-reference/curl/resources/log/enable_paper_trail/_parameters.mdx
- content/pages/01-reference/curl/resources/log/enable_paper_trail/_usage.mdx - content/pages/01-reference/curl/resources/log/enable_paper_trail/_usage.mdx
- content/pages/01-reference/curl/resources/log/enable_paper_trail/_header.mdx - content/pages/01-reference/curl/resources/log/enable_paper_trail/_header.mdx
- content/pages/01-reference/curl/resources/plex/plex.mdx
- content/pages/01-reference/curl/resources/plex/tv/tv.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/get_pin.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/_authentication.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/_response.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/_parameters.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/_usage.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_pin/_header.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/get_token.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/_authentication.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/_response.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/_parameters.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/_usage.mdx
- content/pages/01-reference/curl/resources/plex/tv/get_token/_header.mdx
- content/pages/01-reference/curl/resources/playlists/playlists.mdx - content/pages/01-reference/curl/resources/playlists/playlists.mdx
- content/pages/01-reference/curl/resources/playlists/create_playlist/create_playlist.mdx - content/pages/01-reference/curl/resources/playlists/create_playlist/create_playlist.mdx
- content/pages/01-reference/curl/resources/playlists/create_playlist/_authentication.mdx - content/pages/01-reference/curl/resources/playlists/create_playlist/_authentication.mdx
@@ -2593,7 +2674,7 @@ generatedFiles:
- content/types/operations/get_recently_added_response/curl.mdx - content/types/operations/get_recently_added_response/curl.mdx
- content/types/operations/get_libraries_errors/curl.mdx - content/types/operations/get_libraries_errors/curl.mdx
- content/types/operations/get_libraries_library_response_body/curl.mdx - content/types/operations/get_libraries_library_response_body/curl.mdx
- content/types/operations/location/curl.mdx - content/types/operations/get_libraries_location/curl.mdx
- content/types/operations/get_libraries_directory/curl.mdx - content/types/operations/get_libraries_directory/curl.mdx
- content/types/operations/get_libraries_media_container/curl.mdx - content/types/operations/get_libraries_media_container/curl.mdx
- content/types/operations/get_libraries_response_body/curl.mdx - content/types/operations/get_libraries_response_body/curl.mdx
@@ -2687,6 +2768,16 @@ generatedFiles:
- content/types/operations/enable_paper_trail_errors/curl.mdx - content/types/operations/enable_paper_trail_errors/curl.mdx
- content/types/operations/enable_paper_trail_response_body/curl.mdx - content/types/operations/enable_paper_trail_response_body/curl.mdx
- content/types/operations/enable_paper_trail_response/curl.mdx - content/types/operations/enable_paper_trail_response/curl.mdx
- content/types/operations/get_pin_request/curl.mdx
- content/types/operations/get_pin_errors/curl.mdx
- content/types/operations/get_pin_plex_tv_response_body/curl.mdx
- content/types/operations/location/curl.mdx
- content/types/operations/get_pin_response_body/curl.mdx
- content/types/operations/get_pin_response/curl.mdx
- content/types/operations/get_token_request/curl.mdx
- content/types/operations/get_token_errors/curl.mdx
- content/types/operations/get_token_response_body/curl.mdx
- content/types/operations/get_token_response/curl.mdx
- content/types/operations/query_param_type/curl.mdx - content/types/operations/query_param_type/curl.mdx
- content/types/operations/smart/curl.mdx - content/types/operations/smart/curl.mdx
- content/types/operations/create_playlist_request/curl.mdx - content/types/operations/create_playlist_request/curl.mdx
@@ -3167,6 +3258,22 @@ generatedFiles:
- src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/upload_playlist_content.mdx - src/.gen/pages/01-reference/python/resources/playlists/upload_playlist/upload_playlist_content.mdx
- src/.gen/pages/01-reference/python/resources/playlists/playlists.mdx - src/.gen/pages/01-reference/python/resources/playlists/playlists.mdx
- src/.gen/pages/01-reference/python/resources/playlists/playlists_content.mdx - src/.gen/pages/01-reference/python/resources/playlists/playlists_content.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/_header.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/_parameters.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/_response.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/_usage.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/get_pin.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_pin/get_pin_content.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/_header.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/_parameters.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/_response.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/_usage.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/get_token.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/get_token/get_token_content.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/tv.mdx
- src/.gen/pages/01-reference/python/resources/plex/tv/tv_content.mdx
- src/.gen/pages/01-reference/python/resources/plex/plex.mdx
- src/.gen/pages/01-reference/python/resources/plex/plex_content.mdx
- src/.gen/pages/01-reference/python/resources/search/get_search_results/_header.mdx - src/.gen/pages/01-reference/python/resources/search/get_search_results/_header.mdx
- src/.gen/pages/01-reference/python/resources/search/get_search_results/_parameters.mdx - src/.gen/pages/01-reference/python/resources/search/get_search_results/_parameters.mdx
- src/.gen/pages/01-reference/python/resources/search/get_search_results/_response.mdx - src/.gen/pages/01-reference/python/resources/search/get_search_results/_response.mdx
@@ -3369,6 +3476,10 @@ generatedFiles:
- src/pages/python/playlists/update_playlist/_meta.json - src/pages/python/playlists/update_playlist/_meta.json
- src/pages/python/playlists/upload_playlist/_meta.json - src/pages/python/playlists/upload_playlist/_meta.json
- src/pages/python/playlists/_meta.json - src/pages/python/playlists/_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/get_search_results/_meta.json
- src/pages/python/search/perform_search/_meta.json - src/pages/python/search/perform_search/_meta.json
- src/pages/python/search/perform_voice_search/_meta.json - src/pages/python/search/perform_voice_search/_meta.json
@@ -3635,6 +3746,22 @@ generatedFiles:
- src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/upload_playlist_content.mdx - src/.gen/pages/01-reference/typescript/resources/playlists/upload_playlist/upload_playlist_content.mdx
- src/.gen/pages/01-reference/typescript/resources/playlists/playlists.mdx - src/.gen/pages/01-reference/typescript/resources/playlists/playlists.mdx
- src/.gen/pages/01-reference/typescript/resources/playlists/playlists_content.mdx - src/.gen/pages/01-reference/typescript/resources/playlists/playlists_content.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/_header.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/_parameters.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/_response.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/_usage.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/get_pin.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_pin/get_pin_content.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/_header.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/_parameters.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/_response.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/_usage.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/get_token.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/get_token/get_token_content.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/tv.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/tv/tv_content.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/plex.mdx
- src/.gen/pages/01-reference/typescript/resources/plex/plex_content.mdx
- src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_header.mdx - src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_header.mdx
- src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_parameters.mdx - src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_parameters.mdx
- src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_response.mdx - src/.gen/pages/01-reference/typescript/resources/search/get_search_results/_response.mdx
@@ -3837,6 +3964,10 @@ generatedFiles:
- src/pages/typescript/playlists/update_playlist/_meta.json - src/pages/typescript/playlists/update_playlist/_meta.json
- src/pages/typescript/playlists/upload_playlist/_meta.json - src/pages/typescript/playlists/upload_playlist/_meta.json
- src/pages/typescript/playlists/_meta.json - src/pages/typescript/playlists/_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/get_search_results/_meta.json
- src/pages/typescript/search/perform_search/_meta.json - src/pages/typescript/search/perform_search/_meta.json
- src/pages/typescript/search/perform_voice_search/_meta.json - src/pages/typescript/search/perform_voice_search/_meta.json
@@ -4103,6 +4234,22 @@ generatedFiles:
- src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/upload_playlist_content.mdx - src/.gen/pages/01-reference/go/resources/playlists/upload_playlist/upload_playlist_content.mdx
- src/.gen/pages/01-reference/go/resources/playlists/playlists.mdx - src/.gen/pages/01-reference/go/resources/playlists/playlists.mdx
- src/.gen/pages/01-reference/go/resources/playlists/playlists_content.mdx - src/.gen/pages/01-reference/go/resources/playlists/playlists_content.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/_header.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/_parameters.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/_response.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/_usage.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/get_pin.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_pin/get_pin_content.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/_header.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/_parameters.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/_response.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/_usage.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/get_token.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/get_token/get_token_content.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/tv.mdx
- src/.gen/pages/01-reference/go/resources/plex/tv/tv_content.mdx
- src/.gen/pages/01-reference/go/resources/plex/plex.mdx
- src/.gen/pages/01-reference/go/resources/plex/plex_content.mdx
- src/.gen/pages/01-reference/go/resources/search/get_search_results/_header.mdx - src/.gen/pages/01-reference/go/resources/search/get_search_results/_header.mdx
- src/.gen/pages/01-reference/go/resources/search/get_search_results/_parameters.mdx - src/.gen/pages/01-reference/go/resources/search/get_search_results/_parameters.mdx
- src/.gen/pages/01-reference/go/resources/search/get_search_results/_response.mdx - src/.gen/pages/01-reference/go/resources/search/get_search_results/_response.mdx
@@ -4305,6 +4452,10 @@ generatedFiles:
- src/pages/go/playlists/update_playlist/_meta.json - src/pages/go/playlists/update_playlist/_meta.json
- src/pages/go/playlists/upload_playlist/_meta.json - src/pages/go/playlists/upload_playlist/_meta.json
- src/pages/go/playlists/_meta.json - src/pages/go/playlists/_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/get_search_results/_meta.json
- src/pages/go/search/perform_search/_meta.json - src/pages/go/search/perform_search/_meta.json
- src/pages/go/search/perform_voice_search/_meta.json - src/pages/go/search/perform_voice_search/_meta.json
@@ -4597,6 +4748,24 @@ generatedFiles:
- src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/upload_playlist_content.mdx - src/.gen/pages/01-reference/curl/resources/playlists/upload_playlist/upload_playlist_content.mdx
- src/.gen/pages/01-reference/curl/resources/playlists/playlists.mdx - src/.gen/pages/01-reference/curl/resources/playlists/playlists.mdx
- src/.gen/pages/01-reference/curl/resources/playlists/playlists_content.mdx - src/.gen/pages/01-reference/curl/resources/playlists/playlists_content.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/_authentication.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/_header.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/_parameters.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/_response.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/_usage.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/get_pin.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_pin/get_pin_content.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/_authentication.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/_header.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/_parameters.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/_response.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/_usage.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/get_token.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/get_token/get_token_content.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/tv.mdx
- src/.gen/pages/01-reference/curl/resources/plex/tv/tv_content.mdx
- src/.gen/pages/01-reference/curl/resources/plex/plex.mdx
- src/.gen/pages/01-reference/curl/resources/plex/plex_content.mdx
- src/.gen/pages/01-reference/curl/resources/search/get_search_results/_authentication.mdx - src/.gen/pages/01-reference/curl/resources/search/get_search_results/_authentication.mdx
- src/.gen/pages/01-reference/curl/resources/search/get_search_results/_header.mdx - src/.gen/pages/01-reference/curl/resources/search/get_search_results/_header.mdx
- src/.gen/pages/01-reference/curl/resources/search/get_search_results/_parameters.mdx - src/.gen/pages/01-reference/curl/resources/search/get_search_results/_parameters.mdx
@@ -4810,6 +4979,10 @@ generatedFiles:
- src/pages/curl/playlists/update_playlist/_meta.json - src/pages/curl/playlists/update_playlist/_meta.json
- src/pages/curl/playlists/upload_playlist/_meta.json - src/pages/curl/playlists/upload_playlist/_meta.json
- src/pages/curl/playlists/_meta.json - src/pages/curl/playlists/_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/get_search_results/_meta.json
- src/pages/curl/search/perform_search/_meta.json - src/pages/curl/search/perform_search/_meta.json
- src/pages/curl/search/perform_voice_search/_meta.json - src/pages/curl/search/perform_voice_search/_meta.json

View File

@@ -1,2 +1,12 @@
.PHONY: *
docs: docs:
speakeasy generate docs --schema /github/workspace/openapi/openapi_0 --out ./ --langs python,typescript,go,curl --compile rm -rf src || true
speakeasy generate docs --schema /github/workspace/openapi/openapi_0 --out ./ --langs python,typescript,go,curl --compile
build:
pnpm run build
run-server:
$(MAKE) build
go run server.go

View File

@@ -40,4 +40,10 @@ Based on:
### Changes ### Changes
Based on: Based on:
- OpenAPI Doc 0.0.3 - OpenAPI Doc 0.0.3
- Speakeasy CLI 1.151.0 (2.239.0) https://github.com/speakeasy-api/speakeasy - Speakeasy CLI 1.151.0 (2.239.0) https://github.com/speakeasy-api/speakeasy
## 2024-02-01 00:29:50
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.161.0 (2.245.1) https://github.com/speakeasy-api/speakeasy

View File

@@ -0,0 +1,5 @@
import Tv from "./tv/tv.mdx";
## Plex
<Tv />

View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

View File

@@ -0,0 +1,7 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Pin
<OperationInfo method='post' path='/pins' />
Retrieve a Pin from Plex.tv for authentication flows

View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `X-Plex-Client-Identifier` _string_
Plex Authentication Token
---
##### `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`

View File

@@ -0,0 +1,96 @@
{/* Autogenerated DO NOT EDIT */}
import Location from "/content/types/operations/location/curl.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `id` _number (optional)_
PinID for use with authentication
<br/>
**Example:** `1272322473`
---
##### `code` _string (optional)_
<br/>
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
---
##### `product` _string (optional)_
<br/>
**Example:** `Plex Web`
---
##### `trusted` _boolean (optional)_
---
##### `qr` _string (optional)_
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
<br/>
**Example:** `https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t`
---
##### `clientIdentifier` _string (optional)_
<br/>
**Example:** `Postman`
---
##### `location` _object (optional)_
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Location/>
</Collapsible>
---
##### `expiresIn` _number (optional)_
<br/>
**Example:** `1800`
---
##### `createdAt` _datetime (optional)_
<br/>
**Example:** `2023-04-12 17:00:03 +0000 UTC`
---
##### `expiresAt` _datetime (optional)_
<br/>
**Example:** `2023-04-12 17:30:03 +0000 UTC`
---
##### `authToken` _string (optional)_
---
##### `newRegistration` _string (optional)_
</Collapsible>
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

View File

@@ -0,0 +1,38 @@
<CH.Code>
```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: string'
```
---
```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": "string",
"newRegistration": "string"
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

View File

@@ -0,0 +1,7 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Token
<OperationInfo method='get' path='/pins/{pinID}' />
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

View File

@@ -0,0 +1,8 @@
{/* Autogenerated DO NOT EDIT */}
##### `pinID` _string_
The PinID to retrieve an access token for
---
##### `X-Plex-Client-Identifier` _string_
Plex Authentication Token

View File

@@ -0,0 +1,22 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

View File

@@ -0,0 +1,22 @@
<CH.Code>
```bash Example Request
curl https://plex.tv/api/v2/pins/string \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
--header 'X-Plex-Client-Identifier: string'
```
---
```json Example Response
{
"errors": [
{
"code": 1000,
"message": "X-Plex-Client-Identifier is missing",
"status": 400
}
]
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,15 @@
import GetPin from "./get_pin/get_pin.mdx";
import GetToken from "./get_token/get_token.mdx";
## Tv
### Available Operations
* [Get Pin](/curl/plex/tv/get_pin) - Get a Pin
* [Get Token](/curl/plex/tv/get_token) - Get Access Token
---
<GetPin />
---
<GetToken />

View File

@@ -10,6 +10,7 @@ import Hubs from "./hubs/hubs.mdx";
import Search from "./search/search.mdx"; import Search from "./search/search.mdx";
import Library from "./library/library.mdx"; import Library from "./library/library.mdx";
import Log from "./log/log.mdx"; import Log from "./log/log.mdx";
import Plex from "./plex/plex.mdx";
import Playlists from "./playlists/playlists.mdx"; import Playlists from "./playlists/playlists.mdx";
import Security from "./security/security.mdx"; import Security from "./security/security.mdx";
import Sessions from "./sessions/sessions.mdx"; import Sessions from "./sessions/sessions.mdx";
@@ -39,6 +40,9 @@ import Video from "./video/video.mdx";
--- ---
<Log/> <Log/>
---
<Plex/>
--- ---
<Playlists/> <Playlists/>

View File

@@ -0,0 +1,5 @@
import Tv from "./tv/tv.mdx";
## Plex
<Tv />

View File

@@ -0,0 +1,3 @@
## Get Pin
Retrieve a Pin from Plex.tv for authentication flows

View File

@@ -0,0 +1,19 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `xPlexClientIdentifier` *{`string`}*
Plex Authentication Token
---
##### `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.

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import GetPinResponse from "/content/types/models/operations/get_pin_response/go.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`*operations.GetPinResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetPinResponse />
</Collapsible>
---
##### *{`error`}*

View File

@@ -0,0 +1,63 @@
<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 = "string"
var strong *bool = false
ctx := context.Background()
res, err := s.Plex.Tv.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": "string",
"newRegistration": "string"
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,3 @@
## Get Token
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

View File

@@ -0,0 +1,16 @@
{/* 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`}*
Plex Authentication Token
---
##### `opts` *{`[]operations.Option`}*
The options for this request.

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import GetTokenResponse from "/content/types/models/operations/get_token_response/go.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`*operations.GetTokenResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTokenResponse />
</Collapsible>
---
##### *{`error`}*

View File

@@ -0,0 +1,48 @@
<CH.Code>
```go GetToken.go
package main
import(
"github.com/LukeHagar/plexgo/models/components"
"github.com/LukeHagar/plexgo"
"context"
"log"
"net/http"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
var pinID string = "string"
var xPlexClientIdentifier string = "string"
ctx := context.Background()
res, err := s.Plex.Tv.GetToken(ctx, pinID, xPlexClientIdentifier)
if err != nil {
log.Fatal(err)
}
if res.StatusCode == http.StatusOK {
// handle response
}
}
```
---
```json Example Response
{
"errors": [
{
"code": 1000,
"message": "X-Plex-Client-Identifier is missing",
"status": 400
}
]
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,15 @@
import GetPin from "./get_pin/get_pin.mdx";
import GetToken from "./get_token/get_token.mdx";
## Tv
### Available Operations
* [Get Pin](/go/plex/tv/get_pin) - Get a Pin
* [Get Token](/go/plex/tv/get_token) - Get Access Token
---
<GetPin />
---
<GetToken />

View File

@@ -10,6 +10,7 @@ import Hubs from "./hubs/hubs.mdx";
import Search from "./search/search.mdx"; import Search from "./search/search.mdx";
import Library from "./library/library.mdx"; import Library from "./library/library.mdx";
import Log from "./log/log.mdx"; import Log from "./log/log.mdx";
import Plex from "./plex/plex.mdx";
import Playlists from "./playlists/playlists.mdx"; import Playlists from "./playlists/playlists.mdx";
import Security from "./security/security.mdx"; import Security from "./security/security.mdx";
import Sessions from "./sessions/sessions.mdx"; import Sessions from "./sessions/sessions.mdx";
@@ -39,6 +40,9 @@ import Video from "./video/video.mdx";
--- ---
<Log/> <Log/>
---
<Plex/>
--- ---
<Playlists/> <Playlists/>

View File

@@ -74,5 +74,40 @@ func main() {
} }
} }
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```go
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>"),
)
var xPlexClientIdentifier string = "string"
var strong *bool = false
ctx := context.Background()
res, err := s.Plex.Tv.GetPin(ctx, operations.WithServerURL("https://plex.tv/api/v2"), xPlexClientIdentifier, strong)
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
``` ```
{/* End Go Server Options */} {/* End Go Server Options */}

View File

@@ -0,0 +1,5 @@
import Tv from "./tv/tv.mdx";
## Plex
<Tv />

View File

@@ -0,0 +1,3 @@
## Get Pin
Retrieve a Pin from Plex.tv for authentication flows

View File

@@ -0,0 +1,15 @@
{/* Autogenerated DO NOT EDIT */}
##### `x_plex_client_identifier` *{`str`}*
Plex Authentication Token
---
##### `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.

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
import GetPinResponse from "/content/types/models/operations/get_pin_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetPinResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetPinResponse />
</Collapsible>

View File

@@ -0,0 +1,47 @@
<CH.Code>
```python GetPin.py
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.plex.tv.get_pin(x_plex_client_identifier='string', 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": "string",
"newRegistration": "string"
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,3 @@
## Get Token
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

View File

@@ -0,0 +1,12 @@
{/* Autogenerated DO NOT EDIT */}
##### `pin_id` *{`str`}*
The PinID to retrieve an access token for
---
##### `x_plex_client_identifier` *{`str`}*
Plex Authentication Token
---
##### `server_url` *{`Optional[str]`}*
An optional server URL to use.

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
import GetTokenResponse from "/content/types/models/operations/get_token_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetTokenResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTokenResponse />
</Collapsible>

View File

@@ -0,0 +1,31 @@
<CH.Code>
```python GetToken.py
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.plex.tv.get_token(pin_id='string', x_plex_client_identifier='string')
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>

View File

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

View File

@@ -0,0 +1,15 @@
import GetPin from "./get_pin/get_pin.mdx";
import GetToken from "./get_token/get_token.mdx";
## Tv
### Available Operations
* [Get Pin](/python/plex/tv/get_pin) - Get a Pin
* [Get Token](/python/plex/tv/get_token) - Get Access Token
---
<GetPin />
---
<GetToken />

View File

@@ -10,6 +10,7 @@ import Hubs from "./hubs/hubs.mdx";
import Search from "./search/search.mdx"; import Search from "./search/search.mdx";
import Library from "./library/library.mdx"; import Library from "./library/library.mdx";
import Log from "./log/log.mdx"; import Log from "./log/log.mdx";
import Plex from "./plex/plex.mdx";
import Playlists from "./playlists/playlists.mdx"; import Playlists from "./playlists/playlists.mdx";
import Security from "./security/security.mdx"; import Security from "./security/security.mdx";
import Sessions from "./sessions/sessions.mdx"; import Sessions from "./sessions/sessions.mdx";
@@ -39,6 +40,9 @@ import Video from "./video/video.mdx";
--- ---
<Log/> <Log/>
---
<Plex/>
--- ---
<Playlists/> <Playlists/>

View File

@@ -45,6 +45,25 @@ s = plex_api.PlexAPI(
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
if res.object is not None:
# handle response
pass
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```python
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.plex.tv.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='string', strong=False)
if res.object is not None: if res.object is not None:
# handle response # handle response
pass pass

View File

@@ -1,5 +1,5 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
import TypeT from "/content/types/models/operations/type_t/typescript.mdx" import Type from "/content/types/models/operations/type/typescript.mdx"
import Collapsible from "/src/components/Collapsible"; import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels"; import Labels from "/src/lib/labels";
@@ -7,11 +7,11 @@ import Labels from "/src/lib/labels";
the Id of the library to query the Id of the library to query
--- ---
##### `type`: *{`operations.TypeT`}* ##### `type`: *{`operations.Type`}*
Plex content type to search for Plex content type to search for
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}> <Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<TypeT /> <Type />
</Collapsible> </Collapsible>
--- ---

View File

@@ -2,7 +2,7 @@
<CH.Code> <CH.Code>
```typescript SearchLibrary.ts ```typescript SearchLibrary.ts
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { TypeT } from "@lukehagar/plexjs/models/operations"; import { Type } from "@lukehagar/plexjs/models/operations";
async function run() { async function run() {
const sdk = new PlexAPI({ const sdk = new PlexAPI({
@@ -10,7 +10,7 @@ async function run() {
}); });
const sectionId = 791725; const sectionId = 791725;
const type = TypeT.Four; const type = Type.Four;
const result = await sdk.library.searchLibrary(sectionId, type); const result = await sdk.library.searchLibrary(sectionId, type);

View File

@@ -0,0 +1,5 @@
import Tv from "./tv/tv.mdx";
## Plex
<Tv />

View File

@@ -0,0 +1,3 @@
## Get Pin
Retrieve a Pin from Plex.tv for authentication flows

View File

@@ -0,0 +1,23 @@
{/* Autogenerated DO NOT EDIT */}
##### `xPlexClientIdentifier`: *{`string`}*
Plex Authentication Token
---
##### `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.

View File

@@ -0,0 +1,13 @@
{/* 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>

View File

@@ -0,0 +1,51 @@
<CH.Code>
```typescript GetPin.ts
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
const xPlexClientIdentifier = "string";
const strong = false;
const result = await sdk.plex.tv.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": "string",
"newRegistration": "string"
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,3 @@
## Get Token
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated

View File

@@ -0,0 +1,20 @@
{/* Autogenerated DO NOT EDIT */}
##### `pinID`: *{`string`}*
The PinID to retrieve an access token for
---
##### `xPlexClientIdentifier`: *{`string`}*
Plex Authentication Token
---
##### `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.

View File

@@ -0,0 +1,13 @@
{/* 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>

View File

@@ -0,0 +1,35 @@
<CH.Code>
```typescript GetToken.ts
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
const pinID = "string";
const xPlexClientIdentifier = "string";
const result = await sdk.plex.tv.getToken(pinID, xPlexClientIdentifier);
// Handle the result
console.log(result)
}
run();
```
---
```json Example Response
{
"errors": [
{
"code": 1000,
"message": "X-Plex-Client-Identifier is missing",
"status": 400
}
]
}
```
</CH.Code>

View File

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

View File

@@ -0,0 +1,15 @@
import GetPin from "./get_pin/get_pin.mdx";
import GetToken from "./get_token/get_token.mdx";
## Tv
### Available Operations
* [Get Pin](/typescript/plex/tv/get_pin) - Get a Pin
* [Get Token](/typescript/plex/tv/get_token) - Get Access Token
---
<GetPin />
---
<GetToken />

View File

@@ -10,6 +10,7 @@ import Hubs from "./hubs/hubs.mdx";
import Search from "./search/search.mdx"; import Search from "./search/search.mdx";
import Library from "./library/library.mdx"; import Library from "./library/library.mdx";
import Log from "./log/log.mdx"; import Log from "./log/log.mdx";
import Plex from "./plex/plex.mdx";
import Playlists from "./playlists/playlists.mdx"; import Playlists from "./playlists/playlists.mdx";
import Security from "./security/security.mdx"; import Security from "./security/security.mdx";
import Sessions from "./sessions/sessions.mdx"; import Sessions from "./sessions/sessions.mdx";
@@ -39,6 +40,9 @@ import Video from "./video/video.mdx";
--- ---
<Log/> <Log/>
---
<Plex/>
--- ---
<Playlists/> <Playlists/>

View File

@@ -54,5 +54,31 @@ async function run() {
run(); run();
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
async function run() {
const sdk = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
const xPlexClientIdentifier = "string";
const strong = false;
const result = await sdk.plex.tv.getPin(xPlexClientIdentifier, strong, {
serverURL: "https://plex.tv/api/v2",
});
// Handle the result
console.log(result);
}
run();
``` ```
{/* End Typescript Server Options */} {/* End Typescript Server Options */}

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `code` *{`Optional[float]`}*
<br/>
**Example:** `1000`
---
##### `message` *{`Optional[str]`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `status` *{`Optional[float]`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `code?`: *{`number`}*
<br/>
**Example:** `1000`
---
##### `message?`: *{`string`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `status?`: *{`number`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `errors` *{`List[errors.GetPinErrors]`}*
<Collapsible content={() => import('/content/types/models/errors/get_pin_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `errors?`: *{`errors.GetPinErrors[]`}*
<Collapsible content={() => import('/content/types/models/errors/get_pin_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `code` *{`Optional[float]`}*
<br/>
**Example:** `1000`
---
##### `message` *{`Optional[str]`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `status` *{`Optional[float]`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `code?`: *{`number`}*
<br/>
**Example:** `1000`
---
##### `message?`: *{`string`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `status?`: *{`number`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `errors` *{`List[errors.GetTokenErrors]`}*
<Collapsible content={() => import('/content/types/models/errors/get_token_errors/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `errors?`: *{`errors.GetTokenErrors[]`}*
<Collapsible content={() => import('/content/types/models/errors/get_token_errors/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `rawResponse?`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
**Example:** `0` **Example:** `0`
--- ---
##### `Location` *{`[]operations.Location`}* ##### `Location` *{`[]operations.GetLibrariesLocation`}*
<br/> <br/>
**Example:** `[{"id":1,"path":"/movies"}]` **Example:** `[{"id":1,"path":"/movies"}]`
<Collapsible content={() => import('/content/types/models/operations/location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> <Collapsible content={() => import('/content/types/models/operations/get_libraries_location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
**Example:** `0` **Example:** `0`
--- ---
##### `location` *{`List[operations.Location]`}* ##### `location` *{`List[operations.GetLibrariesLocation]`}*
<br/> <br/>
**Example:** `[{"id":1,"path":"/movies"}]` **Example:** `[{"id":1,"path":"/movies"}]`
<Collapsible content={() => import('/content/types/models/operations/location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> <Collapsible content={() => import('/content/types/models/operations/get_libraries_location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -102,11 +102,11 @@ import Labels from "/src/lib/labels";
**Example:** `0` **Example:** `0`
--- ---
##### `location?`: *{`operations.Location[]`}* ##### `location?`: *{`operations.GetLibrariesLocation[]`}*
<br/> <br/>
**Example:** `[{"id":1,"path":"/movies"}]` **Example:** `[{"id":1,"path":"/movies"}]`
<Collapsible content={() => import('/content/types/models/operations/location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> <Collapsible content={() => import('/content/types/models/operations/get_libraries_location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `ID` *{`*int`}*
<br/>
**Example:** `1`
---
##### `Path` *{`*string`}*
<br/>
**Example:** `/movies`

View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `id` *{`Optional[int]`}*
<br/>
**Example:** `1`
---
##### `path` *{`Optional[str]`}*
<br/>
**Example:** `/movies`

View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
##### `id?`: *{`number`}*
<br/>
**Example:** `1`
---
##### `path?`: *{`string`}*
<br/>
**Example:** `/movies`

View File

@@ -0,0 +1,12 @@
{/* Autogenerated DO NOT EDIT */}
##### `XPlexClientIdentifier` *{`string`}*
Plex Authentication Token
---
##### `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`

View File

@@ -0,0 +1,12 @@
{/* Autogenerated DO NOT EDIT */}
##### `x_plex_client_identifier` *{`str`}*
Plex Authentication Token
---
##### `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`

View File

@@ -0,0 +1,12 @@
{/* Autogenerated DO NOT EDIT */}
##### `xPlexClientIdentifier`: *{`string`}*
Plex Authentication Token
---
##### `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`

View File

@@ -0,0 +1,23 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `ContentType` *{`string`}*
HTTP response content type for this operation
---
##### `StatusCode` *{`int`}*
HTTP response status code for this operation
---
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
Raw HTTP response; suitable for custom response parsing
---
##### `Object` *{`*operations.GetPinResponseBody`}*
The Pin
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -0,0 +1,23 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `content_type` *{`str`}*
HTTP response content type for this operation
---
##### `status_code` *{`int`}*
HTTP response status code for this operation
---
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
Raw HTTP response; suitable for custom response parsing
---
##### `object` *{`Optional[operations.GetPinResponseBody]`}*
The Pin
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -0,0 +1,23 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `contentType`: *{`string`}*
HTTP response content type for this operation
---
##### `statusCode`: *{`number`}*
HTTP response status code for this operation
---
##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
Raw HTTP response; suitable for custom response parsing
---
##### `object?`: *{`operations.GetPinResponseBody`}*
The Pin
<Collapsible content={() => import('/content/types/models/operations/get_pin_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -0,0 +1,64 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `ID` *{`*float64`}*
PinID for use with authentication
<br/>
**Example:** `1272322473`
---
##### `Code` *{`*string`}*
<br/>
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
---
##### `Product` *{`*string`}*
<br/>
**Example:** `Plex Web`
---
##### `Trusted` *{`*bool`}*
---
##### `Qr` *{`*string`}*
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
<br/>
**Example:** `https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t`
---
##### `ClientIdentifier` *{`*string`}*
<br/>
**Example:** `Postman`
---
##### `Location` *{`*operations.Location`}*
<Collapsible content={() => import('/content/types/models/operations/location/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `ExpiresIn` *{`*float64`}*
<br/>
**Example:** `1800`
---
##### `CreatedAt` [*{ `*time.Time` }*](https://pkg.go.dev/time#Time)
<br/>
**Example:** `2023-04-12 17:00:03 +0000 UTC`
---
##### `ExpiresAt` [*{ `*time.Time` }*](https://pkg.go.dev/time#Time)
<br/>
**Example:** `2023-04-12 17:30:03 +0000 UTC`
---
##### `AuthToken` *{`*string`}*
---
##### `NewRegistration` *{`*string`}*

View File

@@ -0,0 +1,64 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `id` *{`Optional[float]`}*
PinID for use with authentication
<br/>
**Example:** `1272322473`
---
##### `code` *{`Optional[str]`}*
<br/>
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
---
##### `product` *{`Optional[str]`}*
<br/>
**Example:** `Plex Web`
---
##### `trusted` *{`Optional[bool]`}*
---
##### `qr` *{`Optional[str]`}*
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
<br/>
**Example:** `https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t`
---
##### `client_identifier` *{`Optional[str]`}*
<br/>
**Example:** `Postman`
---
##### `location` *{`Optional[operations.Location]`}*
<Collapsible content={() => import('/content/types/models/operations/location/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `expires_in` *{`Optional[float]`}*
<br/>
**Example:** `1800`
---
##### `created_at` [*{ `date` }*](https://docs.python.org/3/library/datetime.html#date-objects)
<br/>
**Example:** `2023-04-12 17:00:03 +0000 UTC`
---
##### `expires_at` [*{ `date` }*](https://docs.python.org/3/library/datetime.html#date-objects)
<br/>
**Example:** `2023-04-12 17:30:03 +0000 UTC`
---
##### `auth_token` *{`Optional[str]`}*
---
##### `new_registration` *{`Optional[str]`}*

View File

@@ -0,0 +1,64 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `id?`: *{`number`}*
PinID for use with authentication
<br/>
**Example:** `1272322473`
---
##### `code?`: *{`string`}*
<br/>
**Example:** `3patfx1a78ukcbr7x0n9bl26t`
---
##### `product?`: *{`string`}*
<br/>
**Example:** `Plex Web`
---
##### `trusted?`: *{`boolean`}*
---
##### `qr?`: *{`string`}*
a link to a QR code hosted on plex.tv
The QR code redirects to the relevant `plex.tv/link` authentication page
Which then prompts the user for the 4 Digit Link Pin
<br/>
**Example:** `https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t`
---
##### `clientIdentifier?`: *{`string`}*
<br/>
**Example:** `Postman`
---
##### `location?`: *{`operations.Location`}*
<Collapsible content={() => import('/content/types/models/operations/location/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `expiresIn?`: *{`number`}*
<br/>
**Example:** `1800`
---
##### `createdAt?`: [*{ `Date` }*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
<br/>
**Example:** `2023-04-12 17:00:03 +0000 UTC`
---
##### `expiresAt?`: [*{ `Date` }*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
<br/>
**Example:** `2023-04-12 17:30:03 +0000 UTC`
---
##### `authToken?`: *{`string`}*
---
##### `newRegistration?`: *{`string`}*

View File

@@ -0,0 +1,9 @@
{/* Autogenerated DO NOT EDIT */}
##### `PinID` *{`string`}*
The PinID to retrieve an access token for
---
##### `XPlexClientIdentifier` *{`string`}*
Plex Authentication Token

View File

@@ -0,0 +1,9 @@
{/* Autogenerated DO NOT EDIT */}
##### `pin_id` *{`str`}*
The PinID to retrieve an access token for
---
##### `x_plex_client_identifier` *{`str`}*
Plex Authentication Token

View File

@@ -0,0 +1,9 @@
{/* Autogenerated DO NOT EDIT */}
##### `pinID`: *{`string`}*
The PinID to retrieve an access token for
---
##### `xPlexClientIdentifier`: *{`string`}*
Plex Authentication Token

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `ContentType` *{`string`}*
HTTP response content type for this operation
---
##### `StatusCode` *{`int`}*
HTTP response status code for this operation
---
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `content_type` *{`str`}*
HTTP response content type for this operation
---
##### `status_code` *{`int`}*
HTTP response status code for this operation
---
##### `raw_response` [*{ `requests.Response` }*](https://requests.readthedocs.io/en/latest/api/#requests.Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `contentType`: *{`string`}*
HTTP response content type for this operation
---
##### `statusCode`: *{`number`}*
HTTP response status code for this operation
---
##### `rawResponse`: [*{ `Response` }*](https://developer.mozilla.org/en-US/docs/Web/API/Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -1,11 +1,47 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `ID` *{`*int`}* ##### `Code` *{`*string`}*
<br/> <br/>
**Example:** `1` **Example:** `US`
--- ---
##### `Path` *{`*string`}* ##### `EuropeanUnionMember` *{`*bool`}*
---
##### `ContinentCode` *{`*string`}*
<br/> <br/>
**Example:** `/movies` **Example:** `NA`
---
##### `Country` *{`*string`}*
<br/>
**Example:** `United States`
---
##### `City` *{`*string`}*
<br/>
**Example:** `Austin`
---
##### `TimeZone` *{`*string`}*
<br/>
**Example:** `America/Chicago`
---
##### `PostalCode` *{`*float64`}*
<br/>
**Example:** `78732`
---
##### `InPrivacyRestrictedCountry` *{`*bool`}*
---
##### `Subdivisions` *{`*string`}*
<br/>
**Example:** `Texas`
---
##### `Coordinates` *{`*string`}*
<br/>
**Example:** `30.3768 -97.8935`

View File

@@ -1,11 +1,47 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `id` *{`Optional[int]`}* ##### `code` *{`Optional[str]`}*
<br/> <br/>
**Example:** `1` **Example:** `US`
--- ---
##### `path` *{`Optional[str]`}* ##### `european_union_member` *{`Optional[bool]`}*
---
##### `continent_code` *{`Optional[str]`}*
<br/> <br/>
**Example:** `/movies` **Example:** `NA`
---
##### `country` *{`Optional[str]`}*
<br/>
**Example:** `United States`
---
##### `city` *{`Optional[str]`}*
<br/>
**Example:** `Austin`
---
##### `time_zone` *{`Optional[str]`}*
<br/>
**Example:** `America/Chicago`
---
##### `postal_code` *{`Optional[float]`}*
<br/>
**Example:** `78732`
---
##### `in_privacy_restricted_country` *{`Optional[bool]`}*
---
##### `subdivisions` *{`Optional[str]`}*
<br/>
**Example:** `Texas`
---
##### `coordinates` *{`Optional[str]`}*
<br/>
**Example:** `30.3768 -97.8935`

View File

@@ -1,11 +1,47 @@
{/* Autogenerated DO NOT EDIT */} {/* Autogenerated DO NOT EDIT */}
##### `id?`: *{`number`}* ##### `code?`: *{`string`}*
<br/> <br/>
**Example:** `1` **Example:** `US`
--- ---
##### `path?`: *{`string`}* ##### `europeanUnionMember?`: *{`boolean`}*
---
##### `continentCode?`: *{`string`}*
<br/> <br/>
**Example:** `/movies` **Example:** `NA`
---
##### `country?`: *{`string`}*
<br/>
**Example:** `United States`
---
##### `city?`: *{`string`}*
<br/>
**Example:** `Austin`
---
##### `timeZone?`: *{`string`}*
<br/>
**Example:** `America/Chicago`
---
##### `postalCode?`: *{`number`}*
<br/>
**Example:** `78732`
---
##### `inPrivacyRestrictedCountry?`: *{`boolean`}*
---
##### `subdivisions?`: *{`string`}*
<br/>
**Example:** `Texas`
---
##### `coordinates?`: *{`string`}*
<br/>
**Example:** `30.3768 -97.8935`

View File

@@ -6,10 +6,10 @@ import Labels from "/src/lib/labels";
the Id of the library to query the Id of the library to query
--- ---
##### `type`: *{`operations.TypeT`}* ##### `type`: *{`operations.Type`}*
Plex content type to search for Plex content type to search for
<Collapsible content={() => import('/content/types/models/operations/type_t/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> <Collapsible content={() => import('/content/types/models/operations/type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `Code` *{`*float64`}*
<br/>
**Example:** `1000`
---
##### `Message` *{`*string`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `Status` *{`*float64`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `Errors` *{`[]sdkerrors.GetPinErrors`}*
<Collapsible content={() => import('/content/types/models/sdkerrors/get_pin_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
Raw HTTP response; suitable for custom response parsing

View File

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
##### `Code` *{`*float64`}*
<br/>
**Example:** `1000`
---
##### `Message` *{`*string`}*
<br/>
**Example:** `X-Plex-Client-Identifier is missing`
---
##### `Status` *{`*float64`}*
<br/>
**Example:** `400`

View File

@@ -0,0 +1,14 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `Errors` *{`[]sdkerrors.GetTokenErrors`}*
<Collapsible content={() => import('/content/types/models/sdkerrors/get_token_errors/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---
##### `RawResponse` [*{ `*http.Response` }*](https://pkg.go.dev/net/http#Response)
Raw HTTP response; suitable for custom response parsing

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