diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index a501365..aa2407a 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 7fc33f51-d778-40ef-b094-90972c025d39 management: - docChecksum: 7aba498c024534142941d65a7c2e649c + docChecksum: 95d4ac4070b7f9db42126fc81b258e02 docVersion: 0.0.3 speakeasyVersion: internal - generationVersion: 2.237.3 - releaseVersion: 0.2.0 - configChecksum: 7adcc65dd0834e56b5a7642677ff9159 + generationVersion: 2.239.0 + releaseVersion: 0.2.1 + configChecksum: 5421929b3e489a66ede916e408575cf8 published: true features: docs: @@ -122,6 +122,11 @@ generatedFiles: - content/pages/01-reference/go/resources/library/refresh_library/_response.mdx - content/pages/01-reference/go/resources/library/refresh_library/_usage.mdx - content/pages/01-reference/go/resources/library/refresh_library/refresh_library.mdx + - content/pages/01-reference/go/resources/library/search_library/_header.mdx + - content/pages/01-reference/go/resources/library/search_library/_parameters.mdx + - content/pages/01-reference/go/resources/library/search_library/_response.mdx + - content/pages/01-reference/go/resources/library/search_library/_usage.mdx + - content/pages/01-reference/go/resources/library/search_library/search_library.mdx - content/pages/01-reference/go/resources/log/enable_paper_trail/_header.mdx - content/pages/01-reference/go/resources/log/enable_paper_trail/_parameters.mdx - content/pages/01-reference/go/resources/log/enable_paper_trail/_response.mdx @@ -422,6 +427,11 @@ generatedFiles: - content/pages/01-reference/python/resources/library/refresh_library/_response.mdx - content/pages/01-reference/python/resources/library/refresh_library/_usage.mdx - content/pages/01-reference/python/resources/library/refresh_library/refresh_library.mdx + - content/pages/01-reference/python/resources/library/search_library/_header.mdx + - content/pages/01-reference/python/resources/library/search_library/_parameters.mdx + - content/pages/01-reference/python/resources/library/search_library/_response.mdx + - content/pages/01-reference/python/resources/library/search_library/_usage.mdx + - content/pages/01-reference/python/resources/library/search_library/search_library.mdx - content/pages/01-reference/python/resources/log/enable_paper_trail/_header.mdx - content/pages/01-reference/python/resources/log/enable_paper_trail/_parameters.mdx - content/pages/01-reference/python/resources/log/enable_paper_trail/_response.mdx @@ -722,6 +732,11 @@ generatedFiles: - content/pages/01-reference/typescript/resources/library/refresh_library/_response.mdx - content/pages/01-reference/typescript/resources/library/refresh_library/_usage.mdx - content/pages/01-reference/typescript/resources/library/refresh_library/refresh_library.mdx + - content/pages/01-reference/typescript/resources/library/search_library/_header.mdx + - content/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx + - content/pages/01-reference/typescript/resources/library/search_library/_response.mdx + - content/pages/01-reference/typescript/resources/library/search_library/_usage.mdx + - content/pages/01-reference/typescript/resources/library/search_library/search_library.mdx - content/pages/01-reference/typescript/resources/log/enable_paper_trail/_header.mdx - content/pages/01-reference/typescript/resources/log/enable_paper_trail/_parameters.mdx - content/pages/01-reference/typescript/resources/log/enable_paper_trail/_response.mdx @@ -1702,6 +1717,9 @@ generatedFiles: - content/types/models/operations/get_transcode_sessions_response_body/go.mdx - content/types/models/operations/get_transcode_sessions_response_body/python.mdx - content/types/models/operations/get_transcode_sessions_response_body/typescript.mdx + - content/types/models/operations/get_transient_token_query_param_type/go.mdx + - content/types/models/operations/get_transient_token_query_param_type/python.mdx + - content/types/models/operations/get_transient_token_query_param_type/typescript.mdx - content/types/models/operations/get_transient_token_request/go.mdx - content/types/models/operations/get_transient_token_request/python.mdx - content/types/models/operations/get_transient_token_request/typescript.mdx @@ -1834,6 +1852,21 @@ generatedFiles: - content/types/models/operations/scope/go.mdx - content/types/models/operations/scope/python.mdx - content/types/models/operations/scope/typescript.mdx + - content/types/models/operations/search_library_media_container/go.mdx + - content/types/models/operations/search_library_media_container/python.mdx + - content/types/models/operations/search_library_media_container/typescript.mdx + - content/types/models/operations/search_library_metadata/go.mdx + - content/types/models/operations/search_library_metadata/python.mdx + - content/types/models/operations/search_library_metadata/typescript.mdx + - content/types/models/operations/search_library_request/go.mdx + - content/types/models/operations/search_library_request/python.mdx + - content/types/models/operations/search_library_request/typescript.mdx + - content/types/models/operations/search_library_response/go.mdx + - content/types/models/operations/search_library_response/python.mdx + - content/types/models/operations/search_library_response/typescript.mdx + - content/types/models/operations/search_library_response_body/go.mdx + - content/types/models/operations/search_library_response_body/python.mdx + - content/types/models/operations/search_library_response_body/typescript.mdx - content/types/models/operations/server/go.mdx - content/types/models/operations/server/python.mdx - content/types/models/operations/server/typescript.mdx @@ -2232,6 +2265,12 @@ generatedFiles: - content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx - content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx - content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx + - content/pages/01-reference/curl/resources/library/search_library/search_library.mdx + - content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx + - content/pages/01-reference/curl/resources/library/search_library/_response.mdx + - content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx + - content/pages/01-reference/curl/resources/library/search_library/_usage.mdx + - content/pages/01-reference/curl/resources/library/search_library/_header.mdx - content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx - content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx - content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx @@ -2594,6 +2633,12 @@ generatedFiles: - content/types/operations/refresh_library_errors/curl.mdx - content/types/operations/refresh_library_response_body/curl.mdx - content/types/operations/refresh_library_response/curl.mdx + - content/types/operations/type/curl.mdx + - content/types/operations/search_library_request/curl.mdx + - content/types/operations/search_library_metadata/curl.mdx + - content/types/operations/search_library_media_container/curl.mdx + - content/types/operations/search_library_response_body/curl.mdx + - content/types/operations/search_library_response/curl.mdx - content/types/operations/get_metadata_request/curl.mdx - content/types/operations/get_metadata_errors/curl.mdx - content/types/operations/get_metadata_library_response_body/curl.mdx @@ -2642,7 +2687,7 @@ generatedFiles: - content/types/operations/enable_paper_trail_errors/curl.mdx - content/types/operations/enable_paper_trail_response_body/curl.mdx - content/types/operations/enable_paper_trail_response/curl.mdx - - content/types/operations/type/curl.mdx + - content/types/operations/query_param_type/curl.mdx - content/types/operations/smart/curl.mdx - content/types/operations/create_playlist_request/curl.mdx - content/types/operations/create_playlist_errors/curl.mdx @@ -2705,7 +2750,7 @@ generatedFiles: - content/types/operations/upload_playlist_errors/curl.mdx - content/types/operations/upload_playlist_response_body/curl.mdx - content/types/operations/upload_playlist_response/curl.mdx - - content/types/operations/query_param_type/curl.mdx + - content/types/operations/get_transient_token_query_param_type/curl.mdx - content/types/operations/scope/curl.mdx - content/types/operations/get_transient_token_request/curl.mdx - content/types/operations/get_transient_token_errors/curl.mdx @@ -3018,6 +3063,12 @@ generatedFiles: - src/.gen/pages/01-reference/python/resources/library/refresh_library/_usage.mdx - src/.gen/pages/01-reference/python/resources/library/refresh_library/refresh_library.mdx - src/.gen/pages/01-reference/python/resources/library/refresh_library/refresh_library_content.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/_header.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/_parameters.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/_response.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/_usage.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/search_library.mdx + - src/.gen/pages/01-reference/python/resources/library/search_library/search_library_content.mdx - src/.gen/pages/01-reference/python/resources/library/library.mdx - src/.gen/pages/01-reference/python/resources/library/library_content.mdx - src/.gen/pages/01-reference/python/resources/log/enable_paper_trail/_header.mdx @@ -3289,9 +3340,7 @@ generatedFiles: - src/pages/python/hubs/get_library_hubs/_meta.json - src/pages/python/hubs/_meta.json - src/pages/python/library/delete_library/_meta.json - - src/pages/python/library/get_common_library_items/_meta.json - src/pages/python/library/get_file_hash/_meta.json - - src/pages/python/library/get_latest_library_items/_meta.json - src/pages/python/library/get_libraries/_meta.json - src/pages/python/library/get_library/_meta.json - src/pages/python/library/get_library_items/_meta.json @@ -3300,6 +3349,7 @@ generatedFiles: - src/pages/python/library/get_on_deck/_meta.json - src/pages/python/library/get_recently_added/_meta.json - src/pages/python/library/refresh_library/_meta.json + - src/pages/python/library/search_library/_meta.json - src/pages/python/library/_meta.json - src/pages/python/log/enable_paper_trail/_meta.json - src/pages/python/log/log_line/_meta.json @@ -3481,6 +3531,12 @@ generatedFiles: - src/.gen/pages/01-reference/typescript/resources/library/refresh_library/_usage.mdx - src/.gen/pages/01-reference/typescript/resources/library/refresh_library/refresh_library.mdx - src/.gen/pages/01-reference/typescript/resources/library/refresh_library/refresh_library_content.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/_header.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/_response.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/_usage.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library.mdx + - src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library_content.mdx - src/.gen/pages/01-reference/typescript/resources/library/library.mdx - src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx - src/.gen/pages/01-reference/typescript/resources/log/enable_paper_trail/_header.mdx @@ -3752,9 +3808,7 @@ generatedFiles: - src/pages/typescript/hubs/get_library_hubs/_meta.json - src/pages/typescript/hubs/_meta.json - src/pages/typescript/library/delete_library/_meta.json - - src/pages/typescript/library/get_common_library_items/_meta.json - src/pages/typescript/library/get_file_hash/_meta.json - - src/pages/typescript/library/get_latest_library_items/_meta.json - src/pages/typescript/library/get_libraries/_meta.json - src/pages/typescript/library/get_library/_meta.json - src/pages/typescript/library/get_library_items/_meta.json @@ -3763,6 +3817,7 @@ generatedFiles: - src/pages/typescript/library/get_on_deck/_meta.json - src/pages/typescript/library/get_recently_added/_meta.json - src/pages/typescript/library/refresh_library/_meta.json + - src/pages/typescript/library/search_library/_meta.json - src/pages/typescript/library/_meta.json - src/pages/typescript/log/enable_paper_trail/_meta.json - src/pages/typescript/log/log_line/_meta.json @@ -3944,6 +3999,12 @@ generatedFiles: - src/.gen/pages/01-reference/go/resources/library/refresh_library/_usage.mdx - src/.gen/pages/01-reference/go/resources/library/refresh_library/refresh_library.mdx - src/.gen/pages/01-reference/go/resources/library/refresh_library/refresh_library_content.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/_header.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/_parameters.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/_response.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/_usage.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/search_library.mdx + - src/.gen/pages/01-reference/go/resources/library/search_library/search_library_content.mdx - src/.gen/pages/01-reference/go/resources/library/library.mdx - src/.gen/pages/01-reference/go/resources/library/library_content.mdx - src/.gen/pages/01-reference/go/resources/log/enable_paper_trail/_header.mdx @@ -4215,9 +4276,7 @@ generatedFiles: - src/pages/go/hubs/get_library_hubs/_meta.json - src/pages/go/hubs/_meta.json - src/pages/go/library/delete_library/_meta.json - - src/pages/go/library/get_common_library_items/_meta.json - src/pages/go/library/get_file_hash/_meta.json - - src/pages/go/library/get_latest_library_items/_meta.json - src/pages/go/library/get_libraries/_meta.json - src/pages/go/library/get_library/_meta.json - src/pages/go/library/get_library_items/_meta.json @@ -4226,6 +4285,7 @@ generatedFiles: - src/pages/go/library/get_on_deck/_meta.json - src/pages/go/library/get_recently_added/_meta.json - src/pages/go/library/refresh_library/_meta.json + - src/pages/go/library/search_library/_meta.json - src/pages/go/library/_meta.json - src/pages/go/log/enable_paper_trail/_meta.json - src/pages/go/log/log_line/_meta.json @@ -4417,6 +4477,13 @@ generatedFiles: - src/.gen/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx - src/.gen/pages/01-reference/curl/resources/library/refresh_library/refresh_library.mdx - src/.gen/pages/01-reference/curl/resources/library/refresh_library/refresh_library_content.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/_authentication.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/_header.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/_parameters.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/search_library.mdx + - src/.gen/pages/01-reference/curl/resources/library/search_library/search_library_content.mdx - src/.gen/pages/01-reference/curl/resources/library/library.mdx - src/.gen/pages/01-reference/curl/resources/library/library_content.mdx - src/.gen/pages/01-reference/curl/resources/log/enable_paper_trail/_authentication.mdx @@ -4714,9 +4781,7 @@ generatedFiles: - src/pages/curl/hubs/get_library_hubs/_meta.json - src/pages/curl/hubs/_meta.json - src/pages/curl/library/delete_library/_meta.json - - src/pages/curl/library/get_common_library_items/_meta.json - src/pages/curl/library/get_file_hash/_meta.json - - src/pages/curl/library/get_latest_library_items/_meta.json - src/pages/curl/library/get_libraries/_meta.json - src/pages/curl/library/get_library/_meta.json - src/pages/curl/library/get_library_items/_meta.json @@ -4725,6 +4790,7 @@ generatedFiles: - src/pages/curl/library/get_on_deck/_meta.json - src/pages/curl/library/get_recently_added/_meta.json - src/pages/curl/library/refresh_library/_meta.json + - src/pages/curl/library/search_library/_meta.json - src/pages/curl/library/_meta.json - src/pages/curl/log/enable_paper_trail/_meta.json - src/pages/curl/log/log_line/_meta.json diff --git a/RELEASES.md b/RELEASES.md index f1ea636..7890a65 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -34,4 +34,10 @@ Based on: ### Changes Based on: - OpenAPI Doc 0.0.3 -- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy + +## 2024-01-24 00:31:03 +### Changes +Based on: +- OpenAPI Doc 0.0.3 +- Speakeasy CLI 1.151.0 (2.239.0) https://github.com/speakeasy-api/speakeasy \ No newline at end of file diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx index 5027190..16fbdaf 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx @@ -24,5 +24,4 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index cad2b5e..53f24be 100644 --- a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -24,6 +24,7 @@ curl http://10.10.10.47:32400/library/sections/528895/{{tag}} \ "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 1992ca0..9ad7968 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/5680.45 \ +curl http://10.10.10.47:32400/library/metadata/3927.85 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 73dc215..f0c9b17 100644 --- a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/3927.85/children \ +curl http://10.10.10.47:32400/library/metadata/9255.97/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/library/library.mdx b/content/pages/01-reference/curl/resources/library/library.mdx index dbc7380..9d9c9e1 100644 --- a/content/pages/01-reference/curl/resources/library/library.mdx +++ b/content/pages/01-reference/curl/resources/library/library.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/curl/library/delete_library) - Delete Library Section * [Get Library Items](/curl/library/get_library_items) - Get Library Items * [Refresh Library](/curl/library/refresh_library) - Refresh Library +* [Search Library](/curl/library/search_library) - Search Library * [Get Metadata](/curl/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children * [Get On Deck](/curl/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx b/content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/_authentication.mdx @@ -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: `` + diff --git a/content/pages/01-reference/curl/resources/library/search_library/_header.mdx b/content/pages/01-reference/curl/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..54c126a --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/_header.mdx @@ -0,0 +1,25 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Search Library + + + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. + diff --git a/content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx b/content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..c5ae82f --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/_parameters.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/operations/type/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ +the Id of the library to query + +--- +##### `type` _enumeration_ +Plex content type to search for + + + + + diff --git a/content/pages/01-reference/curl/resources/library/search_library/_response.mdx b/content/pages/01-reference/curl/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..cf771e5 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/_response.mdx @@ -0,0 +1,22 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryMediaContainer from "/content/types/operations/search_library_media_container/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'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + + + diff --git a/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..e2429c9 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/_usage.mdx @@ -0,0 +1,29 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/568045/search \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/search_library/search_library.mdx b/content/pages/01-reference/curl/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/search_library/search_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index c08b4a6..c585a9c 100644 --- a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3682.41/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ +curl http://10.10.10.47:32400/playlists/8326.2/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index fb23a7e..95a9bb1 100644 --- a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/202.18/items \ +curl http://10.10.10.47:32400/playlists/3682.41/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx index b6b73de..0033426 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import Type from "/content/types/operations/type/curl.mdx" +import QueryParamType from "/content/types/operations/query_param_type/curl.mdx" import Smart from "/content/types/operations/smart/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -12,7 +12,7 @@ name of the playlist type of playlist to create - + --- diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 75d9c51..f8e7afa 100644 --- a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=9255.97&title=string&uri=string \ +curl http://10.10.10.47:32400/playlists?playQueueID=8360.79&title=string&uri=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 398e8d7..0ec3d63 100644 --- a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/710.36 \ +curl http://10.10.10.47:32400/playlists/3373.96 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index 00e1dc3..ab6d8d7 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8360.79 \ +curl http://10.10.10.47:32400/playlists/710.36 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index c827cad..c3cff1a 100644 --- a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/871.29/items?type=6481.72 \ +curl http://10.10.10.47:32400/playlists/6481.72/items?type=202.18 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index 32bc5cd..cda38e4 100644 --- a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3373.96?summary=string&title=string \ +curl http://10.10.10.47:32400/playlists/871.29?summary=string&title=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx b/content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx index 9944de6..66ab55b 100644 --- a/content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx +++ b/content/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/operations/query_param_type/curl.mdx" +import GetTransientTokenQueryParamType from "/content/types/operations/get_transient_token_query_param_type/curl.mdx" import Scope from "/content/types/operations/scope/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +8,7 @@ import Labels from "/src/lib/labels"; `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index cefdf4e..9399397 100644 --- a/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=string&duration=7206.33&hasMDE=6788.8&key=string&playBackTime=5820.2&playQueueItemID=6399.21&ratingKey=7805.29&row=1433.53&time=1182.74 \ +curl http://10.10.10.47:32400/:/timeline?context=string&duration=6399.21&hasMDE=1182.74&key=string&playBackTime=1433.53&playQueueItemID=5820.2&ratingKey=6788.8&row=5373.73&time=7206.33 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index 5ac2ead..7f4220a 100644 --- a/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4614.79&audioBoost=7991.59&autoAdjustQuality=5204.78&directPlay=8700.88&directStream=9786.19&fastSeek=8700.13&hasMDE=9571.56&location=string&mediaBufferSize=8009.11&mediaIndex=7781.57&partIndex=1403.5&path=string&protocol=string&session=string&subtites=string&subtitleSize=4736.08 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=5204.78&audioBoost=8009.11&autoAdjustQuality=7805.29&directPlay=9786.19&directStream=4736.08&fastSeek=8700.88&hasMDE=7781.57&location=string&mediaBufferSize=4614.79&mediaIndex=1403.5&partIndex=8700.13&path=string&protocol=string&session=string&subtites=string&subtitleSize=7991.59 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/go/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx index 2d0f43a..cd6b0a3 100644 --- a/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_library_items/_usage.mdx @@ -51,6 +51,7 @@ func main() { "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx index ecc687b..4353e1f 100644 --- a/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_metadata/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var ratingKey float64 = 7917.25 + var ratingKey float64 = 5288.95 ctx := context.Background() res, err := s.Library.GetMetadata(ctx, ratingKey) diff --git a/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx index 54d793a..6501296 100644 --- a/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var ratingKey float64 = 8121.69 + var ratingKey float64 = 4799.77 ctx := context.Background() res, err := s.Library.GetMetadataChildren(ctx, ratingKey) diff --git a/content/pages/01-reference/go/resources/library/library.mdx b/content/pages/01-reference/go/resources/library/library.mdx index 6fba642..361df47 100644 --- a/content/pages/01-reference/go/resources/library/library.mdx +++ b/content/pages/01-reference/go/resources/library/library.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/go/library/delete_library) - Delete Library Section * [Get Library Items](/go/library/get_library_items) - Get Library Items * [Refresh Library](/go/library/refresh_library) - Refresh Library +* [Search Library](/go/library/search_library) - Search Library * [Get Metadata](/go/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children * [Get On Deck](/go/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/content/pages/01-reference/go/resources/library/search_library/_header.mdx b/content/pages/01-reference/go/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/content/pages/01-reference/go/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/go/resources/library/search_library/_parameters.mdx b/content/pages/01-reference/go/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..e6e4f3f --- /dev/null +++ b/content/pages/01-reference/go/resources/library/search_library/_parameters.mdx @@ -0,0 +1,20 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/models/operations/type/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) +The context to use for the request. + +--- +##### `sectionID` *{`int64`}* +the Id of the library to query + +--- +##### `type_` *{`operations.Type`}* +Plex content type to search for + + + + + diff --git a/content/pages/01-reference/go/resources/library/search_library/_response.mdx b/content/pages/01-reference/go/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..94270bb --- /dev/null +++ b/content/pages/01-reference/go/resources/library/search_library/_response.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`*operations.SearchLibraryResponse`}* + + + + + + +--- +##### *{`error`}* + + diff --git a/content/pages/01-reference/go/resources/library/search_library/_usage.mdx b/content/pages/01-reference/go/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..3af69a0 --- /dev/null +++ b/content/pages/01-reference/go/resources/library/search_library/_usage.mdx @@ -0,0 +1,56 @@ + + +```go SearchLibrary.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(""), + ) + + + var sectionID int64 = 791725 + + var type_ operations.Type = operations.TypeFour + + ctx := context.Background() + res, err := s.Library.SearchLibrary(ctx, sectionID, type_) + if err != nil { + log.Fatal(err) + } + + if res.Object != nil { + // handle response + } +} +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/content/pages/01-reference/go/resources/library/search_library/search_library.mdx b/content/pages/01-reference/go/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/go/resources/library/search_library/search_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx index eef517a..58c3201 100644 --- a/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var playlistID float64 = 1403.5 + var playlistID float64 = 8700.88 var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1" diff --git a/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx index fcde240..a2c502f 100644 --- a/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 7781.57 + var playlistID float64 = 8700.13 ctx := context.Background() res, err := s.Playlists.ClearPlaylistContents(ctx, playlistID) diff --git a/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx index 4e21e98..3edd0e4 100644 --- a/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx @@ -19,9 +19,9 @@ func main() { ctx := context.Background() res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{ Title: "string", - Type: operations.TypeVideo, + Type: operations.QueryParamTypeVideo, Smart: operations.SmartOne, - URI: "http://velvety-spiderling.com", + URI: "https://bite-sized-favorite.com", }) if err != nil { log.Fatal(err) diff --git a/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx index d9d5c68..14660a8 100644 --- a/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 202.18 + var playlistID float64 = 8326.2 ctx := context.Background() res, err := s.Playlists.DeletePlaylist(ctx, playlistID) diff --git a/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx index efe3b2f..e706bf8 100644 --- a/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var playlistID float64 = 6481.72 + var playlistID float64 = 3682.41 ctx := context.Background() res, err := s.Playlists.GetPlaylist(ctx, playlistID) diff --git a/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx index e537c19..34fb82d 100644 --- a/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx @@ -16,9 +16,9 @@ func main() { ) - var playlistID float64 = 8326.2 + var playlistID float64 = 7781.57 - var type_ float64 = 9571.56 + var type_ float64 = 1403.5 ctx := context.Background() res, err := s.Playlists.GetPlaylistContents(ctx, playlistID, type_) diff --git a/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx index e85835a..2ca8bb4 100644 --- a/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 3682.41 + var playlistID float64 = 9571.56 var title *string = "string" diff --git a/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx b/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx index 94b51a7..9ac6e99 100644 --- a/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx +++ b/content/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var source string = "provider://provider-identifier" + var source string = "server://client-identifier" ctx := context.Background() res, err := s.Security.GetSourceConnectionInformation(ctx, source) diff --git a/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx b/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx index 955cf47..75f5abe 100644 --- a/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx +++ b/content/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/go.mdx" +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"; @@ -8,11 +8,11 @@ import Labels from "/src/lib/labels"; The context to use for the request. --- -##### `type_` *{`operations.QueryParamType`}* +##### `type_` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx b/content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx index 40fa91e..1d1aa9e 100644 --- a/content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx +++ b/content/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx @@ -18,7 +18,7 @@ func main() { ) - var type_ operations.QueryParamType = operations.QueryParamTypeDelegation + var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation var scope operations.Scope = operations.ScopeAll diff --git a/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx b/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx index a22d4b2..6c7375a 100644 --- a/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx +++ b/content/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx @@ -18,9 +18,9 @@ func main() { ) - var tonight *operations.Tonight = operations.TonightZero + var tonight *operations.Tonight = operations.TonightOne - var skip *operations.Skip = operations.SkipOne + var skip *operations.Skip = operations.SkipZero ctx := context.Background() res, err := s.Updater.ApplyUpdates(ctx, tonight, skip) diff --git a/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx index e8f0a8c..ada86a7 100644 --- a/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/go/resources/video/get_timeline/_usage.mdx @@ -19,16 +19,16 @@ func main() { ctx := context.Background() res, err := s.Video.GetTimeline(ctx, operations.GetTimelineRequest{ - RatingKey: 6788.8, + RatingKey: 7206.33, Key: "", - State: operations.StatePlaying, - HasMDE: 7206.33, - Time: 6399.21, - Duration: 5820.2, + State: operations.StatePaused, + HasMDE: 5820.2, + Time: 1433.53, + Duration: 5373.73, Context: "string", - PlayQueueItemID: 1433.53, - PlayBackTime: 5373.73, - Row: 9446.69, + PlayQueueItemID: 9446.69, + PlayBackTime: 7586.16, + Row: 5218.48, }) if err != nil { log.Fatal(err) diff --git a/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx index 4d40338..06c9fb1 100644 --- a/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx @@ -19,10 +19,10 @@ func main() { ctx := context.Background() res, err := s.Video.StartUniversalTranscode(ctx, operations.StartUniversalTranscodeRequest{ - HasMDE: 8009.11, - Path: "/private", - MediaIndex: 5204.78, - PartIndex: 7805.29, + HasMDE: 5204.78, + Path: "/usr/libexec", + MediaIndex: 6788.8, + PartIndex: 1182.74, Protocol: "string", }) if err != nil { diff --git a/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/python/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx index 923bcd0..610a480 100644 --- a/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_library_items/_usage.mdx @@ -34,6 +34,7 @@ if res.object is not None: "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx index c76aad7..64102d2 100644 --- a/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_metadata/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata(rating_key=7917.25) +res = s.library.get_metadata(rating_key=5288.95) if res.object is not None: # handle response diff --git a/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx index 1433ae8..2781ea4 100644 --- a/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata_children(rating_key=8121.69) +res = s.library.get_metadata_children(rating_key=4799.77) if res.object is not None: # handle response diff --git a/content/pages/01-reference/python/resources/library/library.mdx b/content/pages/01-reference/python/resources/library/library.mdx index e5ecced..18735b9 100644 --- a/content/pages/01-reference/python/resources/library/library.mdx +++ b/content/pages/01-reference/python/resources/library/library.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/python/library/delete_library) - Delete Library Section * [Get Library Items](/python/library/get_library_items) - Get Library Items * [Refresh Library](/python/library/refresh_library) - Refresh Library +* [Search Library](/python/library/search_library) - Search Library * [Get Metadata](/python/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children * [Get On Deck](/python/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/content/pages/01-reference/python/resources/library/search_library/_header.mdx b/content/pages/01-reference/python/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/content/pages/01-reference/python/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/python/resources/library/search_library/_parameters.mdx b/content/pages/01-reference/python/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..89fea58 --- /dev/null +++ b/content/pages/01-reference/python/resources/library/search_library/_parameters.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/models/operations/type/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* +the Id of the library to query + +--- +##### `type` *{`operations.Type`}* +Plex content type to search for + + + + + diff --git a/content/pages/01-reference/python/resources/library/search_library/_response.mdx b/content/pages/01-reference/python/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..0b78f23 --- /dev/null +++ b/content/pages/01-reference/python/resources/library/search_library/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`operations.SearchLibraryResponse`}* + + + + + + + diff --git a/content/pages/01-reference/python/resources/library/search_library/_usage.mdx b/content/pages/01-reference/python/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..57cd3e4 --- /dev/null +++ b/content/pages/01-reference/python/resources/library/search_library/_usage.mdx @@ -0,0 +1,39 @@ + + +```python SearchLibrary.py +import plex_api +from plex_api.models import operations + +s = plex_api.PlexAPI( + access_token="", +) + + +res = s.library.search_library(section_id=791725, type=operations.Type.FOUR) + +if res.object is not None: + # handle response + pass +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/content/pages/01-reference/python/resources/library/search_library/search_library.mdx b/content/pages/01-reference/python/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/python/resources/library/search_library/search_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx index 3946ae0..5223d52 100644 --- a/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) +res = s.playlists.add_playlist_contents(playlist_id=8700.88, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) if res.object is not None: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx index 6db2dc2..9426808 100644 --- a/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.clear_playlist_contents(playlist_id=7781.57) +res = s.playlists.clear_playlist_contents(playlist_id=8700.13) if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx index 7145344..7b263ca 100644 --- a/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx @@ -10,9 +10,9 @@ s = plex_api.PlexAPI( req = operations.CreatePlaylistRequest( title='string', - type=operations.Type.VIDEO, + type=operations.QueryParamType.VIDEO, smart=operations.Smart.ONE, - uri='http://velvety-spiderling.com', + uri='https://bite-sized-favorite.com', ) res = s.playlists.create_playlist(req) diff --git a/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx index 4a23277..f6dffad 100644 --- a/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.delete_playlist(playlist_id=202.18) +res = s.playlists.delete_playlist(playlist_id=8326.2) if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx index cf53d74..a8aff64 100644 --- a/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.get_playlist(playlist_id=6481.72) +res = s.playlists.get_playlist(playlist_id=3682.41) if res.object is not None: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx index b8c549b..2245d51 100644 --- a/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56) +res = s.playlists.get_playlist_contents(playlist_id=7781.57, type=1403.5) if res.object is not None: # handle response diff --git a/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx index 33b1607..bae2298 100644 --- a/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string') +res = s.playlists.update_playlist(playlist_id=9571.56, title='string', summary='string') if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx b/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx index 97bcdd8..4707a44 100644 --- a/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx +++ b/content/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.security.get_source_connection_information(source='provider://provider-identifier') +res = s.security.get_source_connection_information(source='server://client-identifier') if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx b/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx index d7bccd4..05f54a2 100644 --- a/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx +++ b/content/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx @@ -1,14 +1,14 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/python.mdx" +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.QueryParamType`}* +##### `type` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx b/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx index 6d33cbc..27a853c 100644 --- a/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx +++ b/content/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.security.get_transient_token(type=operations.QueryParamType.DELEGATION, scope=operations.Scope.ALL) +res = s.security.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx b/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx index 548e3e8..1ee097d 100644 --- a/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx +++ b/content/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.updater.apply_updates(tonight=operations.Tonight.ZERO, skip=operations.Skip.ONE) +res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ZERO) if res.status_code == 200: # handle response diff --git a/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx index 06d1b7d..c84fefc 100644 --- a/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/python/resources/video/get_timeline/_usage.mdx @@ -9,16 +9,16 @@ s = plex_api.PlexAPI( ) req = operations.GetTimelineRequest( - rating_key=6788.8, + rating_key=7206.33, key='', - state=operations.State.PLAYING, - has_mde=7206.33, - time=6399.21, - duration=5820.2, + state=operations.State.PAUSED, + has_mde=5820.2, + time=1433.53, + duration=5373.73, context='string', - play_queue_item_id=1433.53, - play_back_time=5373.73, - row=9446.69, + play_queue_item_id=9446.69, + play_back_time=7586.16, + row=5218.48, ) res = s.video.get_timeline(req) diff --git a/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx index bcdd699..f791bbc 100644 --- a/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx @@ -9,10 +9,10 @@ s = plex_api.PlexAPI( ) req = operations.StartUniversalTranscodeRequest( - has_mde=8009.11, - path='/private', - media_index=5204.78, - part_index=7805.29, + has_mde=5204.78, + path='/usr/libexec', + media_index=6788.8, + part_index=1182.74, protocol='string', ) diff --git a/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx index 66dea81..0968ccc 100644 --- a/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx @@ -39,6 +39,7 @@ run(); "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx index 7b72a58..b2ab5e8 100644 --- a/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 7917.25; + const ratingKey = 5288.95; const result = await sdk.library.getMetadata(ratingKey); diff --git a/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx index 5a38d26..c5f1071 100644 --- a/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 8121.69; + const ratingKey = 4799.77; const result = await sdk.library.getMetadataChildren(ratingKey); diff --git a/content/pages/01-reference/typescript/resources/library/library.mdx b/content/pages/01-reference/typescript/resources/library/library.mdx index 47efd43..c027ba5 100644 --- a/content/pages/01-reference/typescript/resources/library/library.mdx +++ b/content/pages/01-reference/typescript/resources/library/library.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/typescript/library/delete_library) - Delete Library Section * [Get Library Items](/typescript/library/get_library_items) - Get Library Items * [Refresh Library](/typescript/library/refresh_library) - Refresh Library +* [Search Library](/typescript/library/search_library) - Search Library * [Get Metadata](/typescript/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/typescript/library/get_metadata_children) - Get Items Children * [Get On Deck](/typescript/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/content/pages/01-reference/typescript/resources/library/search_library/_header.mdx b/content/pages/01-reference/typescript/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/content/pages/01-reference/typescript/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/content/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx b/content/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..5d285de --- /dev/null +++ b/content/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx @@ -0,0 +1,24 @@ +{/* Autogenerated DO NOT EDIT */} +import TypeT from "/content/types/models/operations/type_t/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId`: *{`number`}* +the Id of the library to query + +--- +##### `type`: *{`operations.TypeT`}* +Plex content type to search for + + + + + +--- +##### `options?`: *{`RequestOptions`}* +Options for making HTTP requests. + +--- +##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) +Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. + diff --git a/content/pages/01-reference/typescript/resources/library/search_library/_response.mdx b/content/pages/01-reference/typescript/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..4feceaf --- /dev/null +++ b/content/pages/01-reference/typescript/resources/library/search_library/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`Promise`}* + + + + + + + diff --git a/content/pages/01-reference/typescript/resources/library/search_library/_usage.mdx b/content/pages/01-reference/typescript/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..3378364 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/library/search_library/_usage.mdx @@ -0,0 +1,44 @@ + + +```typescript SearchLibrary.ts +import { PlexAPI } from "@lukehagar/plexjs"; +import { TypeT } from "@lukehagar/plexjs/models/operations"; + +async function run() { + const sdk = new PlexAPI({ + accessToken: "", + }); + + const sectionId = 791725; + const type = TypeT.Four; + + const result = await sdk.library.searchLibrary(sectionId, type); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/content/pages/01-reference/typescript/resources/library/search_library/search_library.mdx b/content/pages/01-reference/typescript/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/typescript/resources/library/search_library/search_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx index 03a7b53..cf68417 100644 --- a/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 1403.5; + const playlistID = 8700.88; const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1"; const playQueueID = 123; diff --git a/content/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx index 3f21e88..336daef 100644 --- a/content/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 7781.57; + const playlistID = 8700.13; const result = await sdk.playlists.clearPlaylistContents(playlistID); diff --git a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx index 5e59556..b0f1fcc 100644 --- a/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx @@ -2,7 +2,7 @@ ```typescript CreatePlaylist.ts import { PlexAPI } from "@lukehagar/plexjs"; -import { Smart, TypeT } from "@lukehagar/plexjs/models/operations"; +import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ @@ -11,9 +11,9 @@ async function run() { const result = await sdk.playlists.createPlaylist({ title: "string", - type: TypeT.Video, + type: QueryParamType.Video, smart: Smart.One, - uri: "http://velvety-spiderling.com", + uri: "https://bite-sized-favorite.com", }); // Handle the result diff --git a/content/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx index 86f91e3..d5d567a 100644 --- a/content/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 202.18; + const playlistID = 8326.2; const result = await sdk.playlists.deletePlaylist(playlistID); diff --git a/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx index c9d23cb..ffe43f5 100644 --- a/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 6481.72; + const playlistID = 3682.41; const result = await sdk.playlists.getPlaylist(playlistID); diff --git a/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx index 217e38b..6fd6ff4 100644 --- a/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx @@ -8,8 +8,8 @@ async function run() { accessToken: "", }); - const playlistID = 8326.2; - const type = 9571.56; + const playlistID = 7781.57; + const type = 1403.5; const result = await sdk.playlists.getPlaylistContents(playlistID, type); diff --git a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx index 9bcfad4..3a8749f 100644 --- a/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 3682.41; + const playlistID = 9571.56; const title = "string"; const summary = "string"; diff --git a/content/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx b/content/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx index 493bb5d..1eedabf 100644 --- a/content/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const source = "provider://provider-identifier"; + const source = "server://client-identifier"; const result = await sdk.security.getSourceConnectionInformation(source); diff --git a/content/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx b/content/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx index 761c835..f8aa661 100644 --- a/content/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx +++ b/content/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx @@ -1,14 +1,14 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/typescript.mdx" +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.QueryParamType`}* +##### `type`: *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/content/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx b/content/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx index 9546912..eda6e6f 100644 --- a/content/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx @@ -2,14 +2,14 @@ ```typescript GetTransientToken.ts import { PlexAPI } from "@lukehagar/plexjs"; -import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; +import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ accessToken: "", }); - const type = QueryParamType.Delegation; + const type = GetTransientTokenQueryParamType.Delegation; const scope = Scope.All; const result = await sdk.security.getTransientToken(type, scope); diff --git a/content/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx b/content/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx index 87bed03..89be554 100644 --- a/content/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx @@ -9,8 +9,8 @@ async function run() { accessToken: "", }); - const tonight = Tonight.Zero; - const skip = Skip.One; + const tonight = Tonight.One; + const skip = Skip.Zero; const result = await sdk.updater.applyUpdates(tonight, skip); diff --git a/content/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx b/content/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx index 27fb38e..8b7e5e3 100644 --- a/content/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx @@ -10,16 +10,16 @@ async function run() { }); const result = await sdk.video.getTimeline({ - ratingKey: 6788.8, + ratingKey: 7206.33, key: "", - state: State.Playing, - hasMDE: 7206.33, - time: 6399.21, - duration: 5820.2, + state: State.Paused, + hasMDE: 5820.2, + time: 1433.53, + duration: 5373.73, context: "string", - playQueueItemID: 1433.53, - playBackTime: 5373.73, - row: 9446.69, + playQueueItemID: 9446.69, + playBackTime: 7586.16, + row: 5218.48, }); // Handle the result diff --git a/content/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx b/content/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx index 48b87e8..478374c 100644 --- a/content/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx +++ b/content/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx @@ -9,10 +9,10 @@ async function run() { }); const result = await sdk.video.startUniversalTranscode({ - hasMDE: 8009.11, - path: "/private", - mediaIndex: 5204.78, - partIndex: 7805.29, + hasMDE: 5204.78, + path: "/usr/libexec", + mediaIndex: 6788.8, + partIndex: 1182.74, protocol: "string", }); diff --git a/content/types/models/operations/create_playlist_request/go.mdx b/content/types/models/operations/create_playlist_request/go.mdx index 34685e5..a4a131c 100644 --- a/content/types/models/operations/create_playlist_request/go.mdx +++ b/content/types/models/operations/create_playlist_request/go.mdx @@ -6,10 +6,10 @@ import Labels from "/src/lib/labels"; name of the playlist --- -##### `Type` *{`operations.Type`}* +##### `Type` *{`operations.QueryParamType`}* type of playlist to create - import('/content/types/models/operations/type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/query_param_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/create_playlist_request/python.mdx b/content/types/models/operations/create_playlist_request/python.mdx index a1804b9..bd01838 100644 --- a/content/types/models/operations/create_playlist_request/python.mdx +++ b/content/types/models/operations/create_playlist_request/python.mdx @@ -6,10 +6,10 @@ import Labels from "/src/lib/labels"; name of the playlist --- -##### `type` *{`operations.Type`}* +##### `type` *{`operations.QueryParamType`}* type of playlist to create - import('/content/types/models/operations/type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/query_param_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/create_playlist_request/typescript.mdx b/content/types/models/operations/create_playlist_request/typescript.mdx index 2af0b3c..1115bf2 100644 --- a/content/types/models/operations/create_playlist_request/typescript.mdx +++ b/content/types/models/operations/create_playlist_request/typescript.mdx @@ -6,10 +6,10 @@ import Labels from "/src/lib/labels"; name of the playlist --- -##### `type`: *{`operations.TypeT`}* +##### `type`: *{`operations.QueryParamType`}* type of playlist to create - import('/content/types/models/operations/type_t/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/query_param_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/get_library_items_media_container/go.mdx b/content/types/models/operations/get_library_items_media_container/go.mdx index 5acc060..3cc97fd 100644 --- a/content/types/models/operations/get_library_items_media_container/go.mdx +++ b/content/types/models/operations/get_library_items_media_container/go.mdx @@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
**Example:** `65592` +--- +##### `MixedParents` *{`*bool`}* +
+**Example:** `true` + --- ##### `Metadata` *{`[]operations.GetLibraryItemsMetadata`}*
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` +**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]` import('/content/types/models/operations/get_library_items_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_library_items_media_container/python.mdx b/content/types/models/operations/get_library_items_media_container/python.mdx index 3ce90aa..5337a95 100644 --- a/content/types/models/operations/get_library_items_media_container/python.mdx +++ b/content/types/models/operations/get_library_items_media_container/python.mdx @@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
**Example:** `65592` +--- +##### `mixed_parents` *{`Optional[bool]`}* +
+**Example:** `true` + --- ##### `metadata` *{`List[operations.GetLibraryItemsMetadata]`}*
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` +**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]` import('/content/types/models/operations/get_library_items_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_library_items_media_container/typescript.mdx b/content/types/models/operations/get_library_items_media_container/typescript.mdx index b8912d2..91c13c0 100644 --- a/content/types/models/operations/get_library_items_media_container/typescript.mdx +++ b/content/types/models/operations/get_library_items_media_container/typescript.mdx @@ -71,10 +71,15 @@ import Labels from "/src/lib/labels";
**Example:** `65592` +--- +##### `mixedParents?`: *{`boolean`}* +
+**Example:** `true` + --- ##### `metadata?`: *{`operations.GetLibraryItemsMetadata[]`}*
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` +**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]` import('/content/types/models/operations/get_library_items_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> diff --git a/content/types/models/operations/get_library_items_metadata/go.mdx b/content/types/models/operations/get_library_items_metadata/go.mdx index 43160dc..416ce58 100644 --- a/content/types/models/operations/get_library_items_metadata/go.mdx +++ b/content/types/models/operations/get_library_items_metadata/go.mdx @@ -111,6 +111,41 @@ import Labels from "/src/lib/labels";
**Example:** `rottentomatoes://image.rating.ripe` +--- +##### `GrandparentRatingKey` *{`*string`}* +
+**Example:** `66` + +--- +##### `GrandparentGUID` *{`*string`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `GrandparentKey` *{`*string`}* +
+**Example:** `/library/metadata/66` + +--- +##### `GrandparentTitle` *{`*string`}* +
+**Example:** `Caprica` + +--- +##### `GrandparentThumb` *{`*string`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `GrandparentArt` *{`*string`}* +
+**Example:** `/library/metadata/66/art/1705716261` + +--- +##### `GrandparentTheme` *{`*string`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + --- ##### `Media` *{`[]operations.GetLibraryItemsMedia`}*
@@ -189,4 +224,84 @@ import Labels from "/src/lib/labels";
**Example:** `1` +--- +##### `Index` *{`*int`}* +
+**Example:** `1` + +--- +##### `Theme` *{`*string`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `LeafCount` *{`*int`}* +
+**Example:** `14` + +--- +##### `ViewedLeafCount` *{`*int`}* +
+**Example:** `0` + +--- +##### `ChildCount` *{`*int`}* +
+**Example:** `1` + +--- +##### `HasPremiumExtras` *{`*string`}* +
+**Example:** `1` + +--- +##### `HasPremiumPrimaryExtra` *{`*string`}* +
+**Example:** `1` + +--- +##### `ParentRatingKey` *{`*string`}* +
+**Example:** `66` + +--- +##### `ParentGUID` *{`*string`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `ParentStudio` *{`*string`}* +
+**Example:** `UCP` + +--- +##### `ParentKey` *{`*string`}* +
+**Example:** `/library/metadata/66` + +--- +##### `ParentTitle` *{`*string`}* +
+**Example:** `Caprica` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentYear` *{`*int`}* +
+**Example:** `2010` + +--- +##### `ParentThumb` *{`*string`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `ParentTheme` *{`*string`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + diff --git a/content/types/models/operations/get_library_items_metadata/python.mdx b/content/types/models/operations/get_library_items_metadata/python.mdx index b22dc5e..58f2252 100644 --- a/content/types/models/operations/get_library_items_metadata/python.mdx +++ b/content/types/models/operations/get_library_items_metadata/python.mdx @@ -111,6 +111,41 @@ import Labels from "/src/lib/labels";
**Example:** `rottentomatoes://image.rating.ripe` +--- +##### `grandparent_rating_key` *{`Optional[str]`}* +
+**Example:** `66` + +--- +##### `grandparent_guid` *{`Optional[str]`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `grandparent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66` + +--- +##### `grandparent_title` *{`Optional[str]`}* +
+**Example:** `Caprica` + +--- +##### `grandparent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `grandparent_art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66/art/1705716261` + +--- +##### `grandparent_theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + --- ##### `media` *{`List[operations.GetLibraryItemsMedia]`}*
@@ -189,4 +224,84 @@ import Labels from "/src/lib/labels";
**Example:** `1` +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `leaf_count` *{`Optional[int]`}* +
+**Example:** `14` + +--- +##### `viewed_leaf_count` *{`Optional[int]`}* +
+**Example:** `0` + +--- +##### `child_count` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `has_premium_extras` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `has_premium_primary_extra` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `parent_rating_key` *{`Optional[str]`}* +
+**Example:** `66` + +--- +##### `parent_guid` *{`Optional[str]`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `parent_studio` *{`Optional[str]`}* +
+**Example:** `UCP` + +--- +##### `parent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66` + +--- +##### `parent_title` *{`Optional[str]`}* +
+**Example:** `Caprica` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_year` *{`Optional[int]`}* +
+**Example:** `2010` + +--- +##### `parent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `parent_theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + diff --git a/content/types/models/operations/get_library_items_metadata/typescript.mdx b/content/types/models/operations/get_library_items_metadata/typescript.mdx index d15ef0f..7014e0d 100644 --- a/content/types/models/operations/get_library_items_metadata/typescript.mdx +++ b/content/types/models/operations/get_library_items_metadata/typescript.mdx @@ -111,6 +111,41 @@ import Labels from "/src/lib/labels";
**Example:** `rottentomatoes://image.rating.ripe` +--- +##### `grandparentRatingKey?`: *{`string`}* +
+**Example:** `66` + +--- +##### `grandparentGuid?`: *{`string`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `grandparentKey?`: *{`string`}* +
+**Example:** `/library/metadata/66` + +--- +##### `grandparentTitle?`: *{`string`}* +
+**Example:** `Caprica` + +--- +##### `grandparentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `grandparentArt?`: *{`string`}* +
+**Example:** `/library/metadata/66/art/1705716261` + +--- +##### `grandparentTheme?`: *{`string`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + --- ##### `media?`: *{`operations.GetLibraryItemsMedia[]`}*
@@ -189,4 +224,84 @@ import Labels from "/src/lib/labels";
**Example:** `1` +--- +##### `index?`: *{`number`}* +
+**Example:** `1` + +--- +##### `theme?`: *{`string`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `leafCount?`: *{`number`}* +
+**Example:** `14` + +--- +##### `viewedLeafCount?`: *{`number`}* +
+**Example:** `0` + +--- +##### `childCount?`: *{`number`}* +
+**Example:** `1` + +--- +##### `hasPremiumExtras?`: *{`string`}* +
+**Example:** `1` + +--- +##### `hasPremiumPrimaryExtra?`: *{`string`}* +
+**Example:** `1` + +--- +##### `parentRatingKey?`: *{`string`}* +
+**Example:** `66` + +--- +##### `parentGuid?`: *{`string`}* +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `parentStudio?`: *{`string`}* +
+**Example:** `UCP` + +--- +##### `parentKey?`: *{`string`}* +
+**Example:** `/library/metadata/66` + +--- +##### `parentTitle?`: *{`string`}* +
+**Example:** `Caprica` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentYear?`: *{`number`}* +
+**Example:** `2010` + +--- +##### `parentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `parentTheme?`: *{`string`}* +
+**Example:** `/library/metadata/66/theme/1705716261` + diff --git a/content/types/models/operations/get_transient_token_query_param_type/go.mdx b/content/types/models/operations/get_transient_token_query_param_type/go.mdx new file mode 100644 index 0000000..2c6ceb6 --- /dev/null +++ b/content/types/models/operations/get_transient_token_query_param_type/go.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------ | ------------ | +| `delegation` | delegation | + diff --git a/content/types/models/operations/get_transient_token_query_param_type/python.mdx b/content/types/models/operations/get_transient_token_query_param_type/python.mdx new file mode 100644 index 0000000..2c6ceb6 --- /dev/null +++ b/content/types/models/operations/get_transient_token_query_param_type/python.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------ | ------------ | +| `delegation` | delegation | + diff --git a/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx b/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx new file mode 100644 index 0000000..2c6ceb6 --- /dev/null +++ b/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx @@ -0,0 +1,6 @@ +{/* Autogenerated DO NOT EDIT */} + +| Name | Value | +| ------------ | ------------ | +| `delegation` | delegation | + diff --git a/content/types/models/operations/get_transient_token_request/go.mdx b/content/types/models/operations/get_transient_token_request/go.mdx index f2541b3..1d18c19 100644 --- a/content/types/models/operations/get_transient_token_request/go.mdx +++ b/content/types/models/operations/get_transient_token_request/go.mdx @@ -2,10 +2,10 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `Type` *{`operations.QueryParamType`}* +##### `Type` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - import('/content/types/models/operations/query_param_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_transient_token_query_param_type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/get_transient_token_request/python.mdx b/content/types/models/operations/get_transient_token_request/python.mdx index 50b2d80..d2b4da7 100644 --- a/content/types/models/operations/get_transient_token_request/python.mdx +++ b/content/types/models/operations/get_transient_token_request/python.mdx @@ -2,10 +2,10 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `type` *{`operations.QueryParamType`}* +##### `type` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - import('/content/types/models/operations/query_param_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_transient_token_query_param_type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/get_transient_token_request/typescript.mdx b/content/types/models/operations/get_transient_token_request/typescript.mdx index 11d7cbb..a38b93e 100644 --- a/content/types/models/operations/get_transient_token_request/typescript.mdx +++ b/content/types/models/operations/get_transient_token_request/typescript.mdx @@ -2,10 +2,10 @@ import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; -##### `type`: *{`operations.QueryParamType`}* +##### `type`: *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - import('/content/types/models/operations/query_param_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/models/operations/get_transient_token_query_param_type/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/models/operations/query_param_type/go.mdx b/content/types/models/operations/query_param_type/go.mdx index 2c6ceb6..72710ea 100644 --- a/content/types/models/operations/query_param_type/go.mdx +++ b/content/types/models/operations/query_param_type/go.mdx @@ -1,6 +1,8 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------ | ------------ | -| `delegation` | delegation | +| Name | Value | +| ------- | ------- | +| `audio` | audio | +| `video` | video | +| `photo` | photo | diff --git a/content/types/models/operations/query_param_type/python.mdx b/content/types/models/operations/query_param_type/python.mdx index 2c6ceb6..72710ea 100644 --- a/content/types/models/operations/query_param_type/python.mdx +++ b/content/types/models/operations/query_param_type/python.mdx @@ -1,6 +1,8 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------ | ------------ | -| `delegation` | delegation | +| Name | Value | +| ------- | ------- | +| `audio` | audio | +| `video` | video | +| `photo` | photo | diff --git a/content/types/models/operations/query_param_type/typescript.mdx b/content/types/models/operations/query_param_type/typescript.mdx index 2c6ceb6..72710ea 100644 --- a/content/types/models/operations/query_param_type/typescript.mdx +++ b/content/types/models/operations/query_param_type/typescript.mdx @@ -1,6 +1,8 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------ | ------------ | -| `delegation` | delegation | +| Name | Value | +| ------- | ------- | +| `audio` | audio | +| `video` | video | +| `photo` | photo | diff --git a/content/types/models/operations/search_library_media_container/go.mdx b/content/types/models/operations/search_library_media_container/go.mdx new file mode 100644 index 0000000..1aa988c --- /dev/null +++ b/content/types/models/operations/search_library_media_container/go.mdx @@ -0,0 +1,72 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `Size` *{`*int`}* +
+**Example:** `2` + +--- +##### `AllowSync` *{`*bool`}* +
+**Example:** `false` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/:/resources/show-fanart.jpg` + +--- +##### `Identifier` *{`*string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `MediaTagPrefix` *{`*string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `MediaTagVersion` *{`*int`}* +
+**Example:** `1698860922` + +--- +##### `Nocache` *{`*bool`}* +
+**Example:** `true` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/:/resources/show.png` + +--- +##### `Title1` *{`*string`}* +
+**Example:** `TV Shows` + +--- +##### `Title2` *{`*string`}* +
+**Example:** `Search for ''` + +--- +##### `ViewGroup` *{`*string`}* +
+**Example:** `season` + +--- +##### `ViewMode` *{`*int`}* +
+**Example:** `65593` + +--- +##### `Metadata` *{`[]operations.SearchLibraryMetadata`}* +
+**Example:** `[{"addedAt":1705636916,"art":"/library/metadata/1/art/1705636920","guid":"plex://season/602e67e766dfdb002c0a1b5b","index":1,"key":"/library/metadata/2/children","parentGuid":"plex://show/5d9c086c7d06d9001ffd27aa","parentIndex":1,"parentKey":"/library/metadata/1","parentRatingKey":"1","parentStudio":"Mutant Enemy Productions","parentTheme":"/library/metadata/1/theme/1705636920","parentThumb":"/library/metadata/1/thumb/1705636920","parentTitle":"Firefly","parentYear":2002,"ratingKey":"2","summary":"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.","thumb":"/library/metadata/2/thumb/1705636920","title":"Season 1","type":"season","updatedAt":1705636920}]` + + import('/content/types/models/operations/search_library_metadata/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_media_container/python.mdx b/content/types/models/operations/search_library_media_container/python.mdx new file mode 100644 index 0000000..2c342ce --- /dev/null +++ b/content/types/models/operations/search_library_media_container/python.mdx @@ -0,0 +1,72 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size` *{`Optional[int]`}* +
+**Example:** `2` + +--- +##### `allow_sync` *{`Optional[bool]`}* +
+**Example:** `false` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/:/resources/show-fanart.jpg` + +--- +##### `identifier` *{`Optional[str]`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `media_tag_prefix` *{`Optional[str]`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `media_tag_version` *{`Optional[int]`}* +
+**Example:** `1698860922` + +--- +##### `nocache` *{`Optional[bool]`}* +
+**Example:** `true` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/:/resources/show.png` + +--- +##### `title1` *{`Optional[str]`}* +
+**Example:** `TV Shows` + +--- +##### `title2` *{`Optional[str]`}* +
+**Example:** `Search for ''` + +--- +##### `view_group` *{`Optional[str]`}* +
+**Example:** `season` + +--- +##### `view_mode` *{`Optional[int]`}* +
+**Example:** `65593` + +--- +##### `metadata` *{`List[operations.SearchLibraryMetadata]`}* +
+**Example:** `[{"addedAt":1705636916,"art":"/library/metadata/1/art/1705636920","guid":"plex://season/602e67e766dfdb002c0a1b5b","index":1,"key":"/library/metadata/2/children","parentGuid":"plex://show/5d9c086c7d06d9001ffd27aa","parentIndex":1,"parentKey":"/library/metadata/1","parentRatingKey":"1","parentStudio":"Mutant Enemy Productions","parentTheme":"/library/metadata/1/theme/1705636920","parentThumb":"/library/metadata/1/thumb/1705636920","parentTitle":"Firefly","parentYear":2002,"ratingKey":"2","summary":"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.","thumb":"/library/metadata/2/thumb/1705636920","title":"Season 1","type":"season","updatedAt":1705636920}]` + + import('/content/types/models/operations/search_library_metadata/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_media_container/typescript.mdx b/content/types/models/operations/search_library_media_container/typescript.mdx new file mode 100644 index 0000000..359cc09 --- /dev/null +++ b/content/types/models/operations/search_library_media_container/typescript.mdx @@ -0,0 +1,72 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `size?`: *{`number`}* +
+**Example:** `2` + +--- +##### `allowSync?`: *{`boolean`}* +
+**Example:** `false` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/:/resources/show-fanart.jpg` + +--- +##### `identifier?`: *{`string`}* +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `mediaTagPrefix?`: *{`string`}* +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion?`: *{`number`}* +
+**Example:** `1698860922` + +--- +##### `nocache?`: *{`boolean`}* +
+**Example:** `true` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/:/resources/show.png` + +--- +##### `title1?`: *{`string`}* +
+**Example:** `TV Shows` + +--- +##### `title2?`: *{`string`}* +
+**Example:** `Search for ''` + +--- +##### `viewGroup?`: *{`string`}* +
+**Example:** `season` + +--- +##### `viewMode?`: *{`number`}* +
+**Example:** `65593` + +--- +##### `metadata?`: *{`operations.SearchLibraryMetadata[]`}* +
+**Example:** `[{"addedAt":1705636916,"art":"/library/metadata/1/art/1705636920","guid":"plex://season/602e67e766dfdb002c0a1b5b","index":1,"key":"/library/metadata/2/children","parentGuid":"plex://show/5d9c086c7d06d9001ffd27aa","parentIndex":1,"parentKey":"/library/metadata/1","parentRatingKey":"1","parentStudio":"Mutant Enemy Productions","parentTheme":"/library/metadata/1/theme/1705636920","parentThumb":"/library/metadata/1/thumb/1705636920","parentTitle":"Firefly","parentYear":2002,"ratingKey":"2","summary":"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.","thumb":"/library/metadata/2/thumb/1705636920","title":"Season 1","type":"season","updatedAt":1705636920}]` + + import('/content/types/models/operations/search_library_metadata/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_metadata/go.mdx b/content/types/models/operations/search_library_metadata/go.mdx new file mode 100644 index 0000000..9cb006e --- /dev/null +++ b/content/types/models/operations/search_library_metadata/go.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `RatingKey` *{`*string`}* +
+**Example:** `2` + +--- +##### `Key` *{`*string`}* +
+**Example:** `/library/metadata/2/children` + +--- +##### `ParentRatingKey` *{`*string`}* +
+**Example:** `1` + +--- +##### `GUID` *{`*string`}* +
+**Example:** `plex://season/602e67e766dfdb002c0a1b5b` + +--- +##### `ParentGUID` *{`*string`}* +
+**Example:** `plex://show/5d9c086c7d06d9001ffd27aa` + +--- +##### `ParentStudio` *{`*string`}* +
+**Example:** `Mutant Enemy Productions` + +--- +##### `Type` *{`*string`}* +
+**Example:** `season` + +--- +##### `Title` *{`*string`}* +
+**Example:** `Season 1` + +--- +##### `ParentKey` *{`*string`}* +
+**Example:** `/library/metadata/1` + +--- +##### `ParentTitle` *{`*string`}* +
+**Example:** `Firefly` + +--- +##### `Summary` *{`*string`}* +
+**Example:** `Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship "Serenity". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government "The Alliance"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.` + +--- +##### `Index` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentIndex` *{`*int`}* +
+**Example:** `1` + +--- +##### `ParentYear` *{`*int`}* +
+**Example:** `2002` + +--- +##### `Thumb` *{`*string`}* +
+**Example:** `/library/metadata/2/thumb/1705636920` + +--- +##### `Art` *{`*string`}* +
+**Example:** `/library/metadata/1/art/1705636920` + +--- +##### `ParentThumb` *{`*string`}* +
+**Example:** `/library/metadata/1/thumb/1705636920` + +--- +##### `ParentTheme` *{`*string`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `AddedAt` *{`*int`}* +
+**Example:** `1705636916` + +--- +##### `UpdatedAt` *{`*int`}* +
+**Example:** `1705636920` + + diff --git a/content/types/models/operations/search_library_metadata/python.mdx b/content/types/models/operations/search_library_metadata/python.mdx new file mode 100644 index 0000000..a3508fa --- /dev/null +++ b/content/types/models/operations/search_library_metadata/python.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `rating_key` *{`Optional[str]`}* +
+**Example:** `2` + +--- +##### `key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/2/children` + +--- +##### `parent_rating_key` *{`Optional[str]`}* +
+**Example:** `1` + +--- +##### `guid` *{`Optional[str]`}* +
+**Example:** `plex://season/602e67e766dfdb002c0a1b5b` + +--- +##### `parent_guid` *{`Optional[str]`}* +
+**Example:** `plex://show/5d9c086c7d06d9001ffd27aa` + +--- +##### `parent_studio` *{`Optional[str]`}* +
+**Example:** `Mutant Enemy Productions` + +--- +##### `type` *{`Optional[str]`}* +
+**Example:** `season` + +--- +##### `title` *{`Optional[str]`}* +
+**Example:** `Season 1` + +--- +##### `parent_key` *{`Optional[str]`}* +
+**Example:** `/library/metadata/1` + +--- +##### `parent_title` *{`Optional[str]`}* +
+**Example:** `Firefly` + +--- +##### `summary` *{`Optional[str]`}* +
+**Example:** `Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship "Serenity". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government "The Alliance"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.` + +--- +##### `index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_index` *{`Optional[int]`}* +
+**Example:** `1` + +--- +##### `parent_year` *{`Optional[int]`}* +
+**Example:** `2002` + +--- +##### `thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/2/thumb/1705636920` + +--- +##### `art` *{`Optional[str]`}* +
+**Example:** `/library/metadata/1/art/1705636920` + +--- +##### `parent_thumb` *{`Optional[str]`}* +
+**Example:** `/library/metadata/1/thumb/1705636920` + +--- +##### `parent_theme` *{`Optional[str]`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `added_at` *{`Optional[int]`}* +
+**Example:** `1705636916` + +--- +##### `updated_at` *{`Optional[int]`}* +
+**Example:** `1705636920` + + diff --git a/content/types/models/operations/search_library_metadata/typescript.mdx b/content/types/models/operations/search_library_metadata/typescript.mdx new file mode 100644 index 0000000..9a105cd --- /dev/null +++ b/content/types/models/operations/search_library_metadata/typescript.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey?`: *{`string`}* +
+**Example:** `2` + +--- +##### `key?`: *{`string`}* +
+**Example:** `/library/metadata/2/children` + +--- +##### `parentRatingKey?`: *{`string`}* +
+**Example:** `1` + +--- +##### `guid?`: *{`string`}* +
+**Example:** `plex://season/602e67e766dfdb002c0a1b5b` + +--- +##### `parentGuid?`: *{`string`}* +
+**Example:** `plex://show/5d9c086c7d06d9001ffd27aa` + +--- +##### `parentStudio?`: *{`string`}* +
+**Example:** `Mutant Enemy Productions` + +--- +##### `type?`: *{`string`}* +
+**Example:** `season` + +--- +##### `title?`: *{`string`}* +
+**Example:** `Season 1` + +--- +##### `parentKey?`: *{`string`}* +
+**Example:** `/library/metadata/1` + +--- +##### `parentTitle?`: *{`string`}* +
+**Example:** `Firefly` + +--- +##### `summary?`: *{`string`}* +
+**Example:** `Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship "Serenity". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government "The Alliance"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.` + +--- +##### `index?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentIndex?`: *{`number`}* +
+**Example:** `1` + +--- +##### `parentYear?`: *{`number`}* +
+**Example:** `2002` + +--- +##### `thumb?`: *{`string`}* +
+**Example:** `/library/metadata/2/thumb/1705636920` + +--- +##### `art?`: *{`string`}* +
+**Example:** `/library/metadata/1/art/1705636920` + +--- +##### `parentThumb?`: *{`string`}* +
+**Example:** `/library/metadata/1/thumb/1705636920` + +--- +##### `parentTheme?`: *{`string`}* +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `addedAt?`: *{`number`}* +
+**Example:** `1705636916` + +--- +##### `updatedAt?`: *{`number`}* +
+**Example:** `1705636920` + + diff --git a/content/types/models/operations/search_library_request/go.mdx b/content/types/models/operations/search_library_request/go.mdx new file mode 100644 index 0000000..bb7bc71 --- /dev/null +++ b/content/types/models/operations/search_library_request/go.mdx @@ -0,0 +1,15 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `SectionID` *{`int64`}* +the Id of the library to query + +--- +##### `Type` *{`operations.Type`}* +Plex content type to search for + + import('/content/types/models/operations/type/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_request/python.mdx b/content/types/models/operations/search_library_request/python.mdx new file mode 100644 index 0000000..5902d7b --- /dev/null +++ b/content/types/models/operations/search_library_request/python.mdx @@ -0,0 +1,15 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* +the Id of the library to query + +--- +##### `type` *{`operations.Type`}* +Plex content type to search for + + import('/content/types/models/operations/type/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_request/typescript.mdx b/content/types/models/operations/search_library_request/typescript.mdx new file mode 100644 index 0000000..3387f40 --- /dev/null +++ b/content/types/models/operations/search_library_request/typescript.mdx @@ -0,0 +1,15 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId`: *{`number`}* +the Id of the library to query + +--- +##### `type`: *{`operations.TypeT`}* +Plex content type to search for + + import('/content/types/models/operations/type_t/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response/go.mdx b/content/types/models/operations/search_library_response/go.mdx new file mode 100644 index 0000000..3b800e5 --- /dev/null +++ b/content/types/models/operations/search_library_response/go.mdx @@ -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.SearchLibraryResponseBody`}* +The contents of the library by section and type + + import('/content/types/models/operations/search_library_response_body/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response/python.mdx b/content/types/models/operations/search_library_response/python.mdx new file mode 100644 index 0000000..936a00a --- /dev/null +++ b/content/types/models/operations/search_library_response/python.mdx @@ -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.SearchLibraryResponseBody]`}* +The contents of the library by section and type + + import('/content/types/models/operations/search_library_response_body/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response/typescript.mdx b/content/types/models/operations/search_library_response/typescript.mdx new file mode 100644 index 0000000..8ae012e --- /dev/null +++ b/content/types/models/operations/search_library_response/typescript.mdx @@ -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.SearchLibraryResponseBody`}* +The contents of the library by section and type + + import('/content/types/models/operations/search_library_response_body/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response_body/go.mdx b/content/types/models/operations/search_library_response_body/go.mdx new file mode 100644 index 0000000..ea46d8b --- /dev/null +++ b/content/types/models/operations/search_library_response_body/go.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `MediaContainer` *{`*operations.SearchLibraryMediaContainer`}* + + import('/content/types/models/operations/search_library_media_container/go.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response_body/python.mdx b/content/types/models/operations/search_library_response_body/python.mdx new file mode 100644 index 0000000..44281d0 --- /dev/null +++ b/content/types/models/operations/search_library_response_body/python.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `media_container` *{`Optional[operations.SearchLibraryMediaContainer]`}* + + import('/content/types/models/operations/search_library_media_container/python.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/search_library_response_body/typescript.mdx b/content/types/models/operations/search_library_response_body/typescript.mdx new file mode 100644 index 0000000..099e15f --- /dev/null +++ b/content/types/models/operations/search_library_response_body/typescript.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer?`: *{`operations.SearchLibraryMediaContainer`}* + + import('/content/types/models/operations/search_library_media_container/typescript.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/models/operations/tag/go.mdx b/content/types/models/operations/tag/go.mdx index 45730ae..01a2974 100644 --- a/content/types/models/operations/tag/go.mdx +++ b/content/types/models/operations/tag/go.mdx @@ -1,25 +1,24 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------------ | ------------------ | -| `all` | all | -| `unwatched` | unwatched | -| `newest` | newest | -| `recentlyAdded` | recentlyAdded | -| `recentlyViewed` | recentlyViewed | -| `onDeck` | onDeck | -| `collection` | collection | -| `edition` | edition | -| `genre` | genre | -| `year` | year | -| `decade` | decade | -| `director` | director | -| `actor` | actor | -| `country` | country | -| `contentRating` | contentRating | -| `rating` | rating | -| `resolution` | resolution | -| `firstCharacter` | firstCharacter | -| `folder` | folder | -| `searchTypeEqual1` | search?type=1 | +| Name | Value | +| ---------------- | ---------------- | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | diff --git a/content/types/models/operations/tag/python.mdx b/content/types/models/operations/tag/python.mdx index 45730ae..01a2974 100644 --- a/content/types/models/operations/tag/python.mdx +++ b/content/types/models/operations/tag/python.mdx @@ -1,25 +1,24 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------------ | ------------------ | -| `all` | all | -| `unwatched` | unwatched | -| `newest` | newest | -| `recentlyAdded` | recentlyAdded | -| `recentlyViewed` | recentlyViewed | -| `onDeck` | onDeck | -| `collection` | collection | -| `edition` | edition | -| `genre` | genre | -| `year` | year | -| `decade` | decade | -| `director` | director | -| `actor` | actor | -| `country` | country | -| `contentRating` | contentRating | -| `rating` | rating | -| `resolution` | resolution | -| `firstCharacter` | firstCharacter | -| `folder` | folder | -| `searchTypeEqual1` | search?type=1 | +| Name | Value | +| ---------------- | ---------------- | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | diff --git a/content/types/models/operations/tag/typescript.mdx b/content/types/models/operations/tag/typescript.mdx index 45730ae..01a2974 100644 --- a/content/types/models/operations/tag/typescript.mdx +++ b/content/types/models/operations/tag/typescript.mdx @@ -1,25 +1,24 @@ {/* Autogenerated DO NOT EDIT */} -| Name | Value | -| ------------------ | ------------------ | -| `all` | all | -| `unwatched` | unwatched | -| `newest` | newest | -| `recentlyAdded` | recentlyAdded | -| `recentlyViewed` | recentlyViewed | -| `onDeck` | onDeck | -| `collection` | collection | -| `edition` | edition | -| `genre` | genre | -| `year` | year | -| `decade` | decade | -| `director` | director | -| `actor` | actor | -| `country` | country | -| `contentRating` | contentRating | -| `rating` | rating | -| `resolution` | resolution | -| `firstCharacter` | firstCharacter | -| `folder` | folder | -| `searchTypeEqual1` | search?type=1 | +| Name | Value | +| ---------------- | ---------------- | +| `all` | all | +| `unwatched` | unwatched | +| `newest` | newest | +| `recentlyAdded` | recentlyAdded | +| `recentlyViewed` | recentlyViewed | +| `onDeck` | onDeck | +| `collection` | collection | +| `edition` | edition | +| `genre` | genre | +| `year` | year | +| `decade` | decade | +| `director` | director | +| `actor` | actor | +| `country` | country | +| `contentRating` | contentRating | +| `rating` | rating | +| `resolution` | resolution | +| `firstCharacter` | firstCharacter | +| `folder` | folder | diff --git a/content/types/models/operations/type/go.mdx b/content/types/models/operations/type/go.mdx index 72710ea..7a466fc 100644 --- a/content/types/models/operations/type/go.mdx +++ b/content/types/models/operations/type/go.mdx @@ -2,7 +2,8 @@ | Name | Value | | ------- | ------- | -| `audio` | audio | -| `video` | video | -| `photo` | photo | +| `one` | 1 | +| `two` | 2 | +| `three` | 3 | +| `four` | 4 | diff --git a/content/types/models/operations/type/python.mdx b/content/types/models/operations/type/python.mdx index 72710ea..7a466fc 100644 --- a/content/types/models/operations/type/python.mdx +++ b/content/types/models/operations/type/python.mdx @@ -2,7 +2,8 @@ | Name | Value | | ------- | ------- | -| `audio` | audio | -| `video` | video | -| `photo` | photo | +| `one` | 1 | +| `two` | 2 | +| `three` | 3 | +| `four` | 4 | diff --git a/content/types/models/operations/type_t/typescript.mdx b/content/types/models/operations/type_t/typescript.mdx index 72710ea..7a466fc 100644 --- a/content/types/models/operations/type_t/typescript.mdx +++ b/content/types/models/operations/type_t/typescript.mdx @@ -2,7 +2,8 @@ | Name | Value | | ------- | ------- | -| `audio` | audio | -| `video` | video | -| `photo` | photo | +| `one` | 1 | +| `two` | 2 | +| `three` | 3 | +| `four` | 4 | diff --git a/content/types/operations/create_playlist_request/curl.mdx b/content/types/operations/create_playlist_request/curl.mdx index 223bec7..0260348 100644 --- a/content/types/operations/create_playlist_request/curl.mdx +++ b/content/types/operations/create_playlist_request/curl.mdx @@ -9,7 +9,7 @@ name of the playlist ##### `type` _enumeration_ type of playlist to create - import('/content/types/operations/type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/operations/query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/operations/get_library_items_media_container/curl.mdx b/content/types/operations/get_library_items_media_container/curl.mdx index 55686b7..46f0b0b 100644 --- a/content/types/operations/get_library_items_media_container/curl.mdx +++ b/content/types/operations/get_library_items_media_container/curl.mdx @@ -68,9 +68,14 @@
**Example:** `65592` +--- +##### `mixedParents` _boolean (optional)_ +
+**Example:** `true` + --- ##### `metadata` _array (optional)_
-**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","contentRating":"PG-13","duration":11558112,"guid":"plex://movie/5d7768ba96b655001fdc0408","key":"/library/metadata/58683","lastViewedAt":1682752242,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"year":2022}]` +**Example:** `[{"Country":[{"tag":"United States of America"}],"Director":[{"tag":"James Cameron"}],"Genre":[{"tag":"Action"},{"tag":"Adventure"}],"Media":[{"Part":[{"container":"mkv","duration":11558112,"file":"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv","id":119542,"key":"/library/parts/119542/1680457526/file.mkv","size":36158371307,"videoProfile":"main 10"}],"aspectRatio":1.85,"audioChannels":6,"audioCodec":"eac3","bitrate":25025,"container":"mkv","duration":11558112,"height":2072,"id":119534,"videoCodec":"hevc","videoFrameRate":"24p","videoProfile":"main 10","videoResolution":"4k","width":3840}],"Role":[{"tag":"Sam Worthington"},{"tag":"Zoe Saldaña"},{"tag":"Sigourney Weaver"}],"Writer":[{"tag":"Josh Friedman"},{"tag":"James Cameron"}],"addedAt":1680457607,"art":"/library/metadata/58683/art/1703239236","audienceRating":9.2,"audienceRatingImage":"rottentomatoes://image.rating.upright","chapterSource":"media","childCount":1,"contentRating":"PG-13","duration":11558112,"grandparentArt":"/library/metadata/66/art/1705716261","grandparentGuid":"plex://show/5d9c081b170e24001f2a7be4","grandparentKey":"/library/metadata/66","grandparentRatingKey":"66","grandparentTheme":"/library/metadata/66/theme/1705716261","grandparentThumb":"/library/metadata/66/thumb/1705716261","grandparentTitle":"Caprica","guid":"plex://movie/5d7768ba96b655001fdc0408","hasPremiumExtras":"1","hasPremiumPrimaryExtra":"1","index":1,"key":"/library/metadata/58683","lastViewedAt":1682752242,"leafCount":14,"originalTitle":"映画 ブラッククローバー 魔法帝の剣","originallyAvailableAt":"2022-12-14T00:00:00Z","parentGuid":"plex://show/5d9c081b170e24001f2a7be4","parentIndex":1,"parentKey":"/library/metadata/66","parentRatingKey":"66","parentStudio":"UCP","parentTheme":"/library/metadata/66/theme/1705716261","parentThumb":"/library/metadata/66/thumb/1705716261","parentTitle":"Caprica","parentYear":2010,"primaryExtraKey":"/library/metadata/58684","rating":7.6,"ratingImage":"rottentomatoes://image.rating.ripe","ratingKey":"58683","skipCount":1,"studio":"20th Century Studios","summary":"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.","tagline":"Return to Pandora.","theme":"/library/metadata/1/theme/1705636920","thumb":"/library/metadata/58683/thumb/1703239236","title":"Avatar: The Way of Water","titleSort":"Whale","type":"movie","updatedAt":1703239236,"viewCount":1,"viewOffset":5222500,"viewedLeafCount":0,"year":2022}]` diff --git a/content/types/operations/get_library_items_metadata/curl.mdx b/content/types/operations/get_library_items_metadata/curl.mdx index 983f9bf..cf48661 100644 --- a/content/types/operations/get_library_items_metadata/curl.mdx +++ b/content/types/operations/get_library_items_metadata/curl.mdx @@ -108,6 +108,41 @@
**Example:** `rottentomatoes://image.rating.ripe` +--- +##### `grandparentRatingKey` _string (optional)_ +
+**Example:** `66` + +--- +##### `grandparentGuid` _string (optional)_ +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `grandparentKey` _string (optional)_ +
+**Example:** `/library/metadata/66` + +--- +##### `grandparentTitle` _string (optional)_ +
+**Example:** `Caprica` + +--- +##### `grandparentThumb` _string (optional)_ +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `grandparentArt` _string (optional)_ +
+**Example:** `/library/metadata/66/art/1705716261` + +--- +##### `grandparentTheme` _string (optional)_ +
+**Example:** `/library/metadata/66/theme/1705716261` + --- ##### `media` _array (optional)_
@@ -168,4 +203,84 @@
**Example:** `1` +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `theme` _string (optional)_ +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `leafCount` _integer (32-bit) (optional)_ +
+**Example:** `14` + +--- +##### `viewedLeafCount` _integer (32-bit) (optional)_ +
+**Example:** `0` + +--- +##### `childCount` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `hasPremiumExtras` _string (optional)_ +
+**Example:** `1` + +--- +##### `hasPremiumPrimaryExtra` _string (optional)_ +
+**Example:** `1` + +--- +##### `parentRatingKey` _string (optional)_ +
+**Example:** `66` + +--- +##### `parentGuid` _string (optional)_ +
+**Example:** `plex://show/5d9c081b170e24001f2a7be4` + +--- +##### `parentStudio` _string (optional)_ +
+**Example:** `UCP` + +--- +##### `parentKey` _string (optional)_ +
+**Example:** `/library/metadata/66` + +--- +##### `parentTitle` _string (optional)_ +
+**Example:** `Caprica` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentYear` _integer (32-bit) (optional)_ +
+**Example:** `2010` + +--- +##### `parentThumb` _string (optional)_ +
+**Example:** `/library/metadata/66/thumb/1705716261` + +--- +##### `parentTheme` _string (optional)_ +
+**Example:** `/library/metadata/66/theme/1705716261` + diff --git a/content/types/operations/get_transient_token_query_param_type/curl.mdx b/content/types/operations/get_transient_token_query_param_type/curl.mdx new file mode 100644 index 0000000..7af7a4b --- /dev/null +++ b/content/types/operations/get_transient_token_query_param_type/curl.mdx @@ -0,0 +1,4 @@ +{/* Autogenerated DO NOT EDIT */} + +Allowed values: `delegation` + diff --git a/content/types/operations/get_transient_token_request/curl.mdx b/content/types/operations/get_transient_token_request/curl.mdx index 285d0f4..50f9ade 100644 --- a/content/types/operations/get_transient_token_request/curl.mdx +++ b/content/types/operations/get_transient_token_request/curl.mdx @@ -5,7 +5,7 @@ import Labels from "/src/lib/labels"; ##### `type` _enumeration_ `delegation` \- This is the only supported `type` parameter. - import('/content/types/operations/query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + import('/content/types/operations/get_transient_token_query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> --- diff --git a/content/types/operations/query_param_type/curl.mdx b/content/types/operations/query_param_type/curl.mdx index 7af7a4b..a7f4d22 100644 --- a/content/types/operations/query_param_type/curl.mdx +++ b/content/types/operations/query_param_type/curl.mdx @@ -1,4 +1,4 @@ {/* Autogenerated DO NOT EDIT */} -Allowed values: `delegation` +Allowed values: `audio` `video` `photo` diff --git a/content/types/operations/search_library_media_container/curl.mdx b/content/types/operations/search_library_media_container/curl.mdx new file mode 100644 index 0000000..4f41a76 --- /dev/null +++ b/content/types/operations/search_library_media_container/curl.mdx @@ -0,0 +1,66 @@ +{/* Autogenerated DO NOT EDIT */} +##### `size` _integer (32-bit) (optional)_ +
+**Example:** `2` + +--- +##### `allowSync` _boolean (optional)_ +
+**Example:** `false` + +--- +##### `art` _string (optional)_ +
+**Example:** `/:/resources/show-fanart.jpg` + +--- +##### `identifier` _string (optional)_ +
+**Example:** `com.plexapp.plugins.library` + +--- +##### `mediaTagPrefix` _string (optional)_ +
+**Example:** `/system/bundle/media/flags/` + +--- +##### `mediaTagVersion` _integer (32-bit) (optional)_ +
+**Example:** `1698860922` + +--- +##### `nocache` _boolean (optional)_ +
+**Example:** `true` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/:/resources/show.png` + +--- +##### `title1` _string (optional)_ +
+**Example:** `TV Shows` + +--- +##### `title2` _string (optional)_ +
+**Example:** `Search for ''` + +--- +##### `viewGroup` _string (optional)_ +
+**Example:** `season` + +--- +##### `viewMode` _integer (32-bit) (optional)_ +
+**Example:** `65593` + +--- +##### `metadata` _array (optional)_ +
+**Example:** `[{"addedAt":1705636916,"art":"/library/metadata/1/art/1705636920","guid":"plex://season/602e67e766dfdb002c0a1b5b","index":1,"key":"/library/metadata/2/children","parentGuid":"plex://show/5d9c086c7d06d9001ffd27aa","parentIndex":1,"parentKey":"/library/metadata/1","parentRatingKey":"1","parentStudio":"Mutant Enemy Productions","parentTheme":"/library/metadata/1/theme/1705636920","parentThumb":"/library/metadata/1/thumb/1705636920","parentTitle":"Firefly","parentYear":2002,"ratingKey":"2","summary":"Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.","thumb":"/library/metadata/2/thumb/1705636920","title":"Season 1","type":"season","updatedAt":1705636920}]` + + diff --git a/content/types/operations/search_library_metadata/curl.mdx b/content/types/operations/search_library_metadata/curl.mdx new file mode 100644 index 0000000..0f273b1 --- /dev/null +++ b/content/types/operations/search_library_metadata/curl.mdx @@ -0,0 +1,101 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _string (optional)_ +
+**Example:** `2` + +--- +##### `key` _string (optional)_ +
+**Example:** `/library/metadata/2/children` + +--- +##### `parentRatingKey` _string (optional)_ +
+**Example:** `1` + +--- +##### `guid` _string (optional)_ +
+**Example:** `plex://season/602e67e766dfdb002c0a1b5b` + +--- +##### `parentGuid` _string (optional)_ +
+**Example:** `plex://show/5d9c086c7d06d9001ffd27aa` + +--- +##### `parentStudio` _string (optional)_ +
+**Example:** `Mutant Enemy Productions` + +--- +##### `type` _string (optional)_ +
+**Example:** `season` + +--- +##### `title` _string (optional)_ +
+**Example:** `Season 1` + +--- +##### `parentKey` _string (optional)_ +
+**Example:** `/library/metadata/1` + +--- +##### `parentTitle` _string (optional)_ +
+**Example:** `Firefly` + +--- +##### `summary` _string (optional)_ +
+**Example:** `Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship "Serenity". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government "The Alliance"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.` + +--- +##### `index` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentIndex` _integer (32-bit) (optional)_ +
+**Example:** `1` + +--- +##### `parentYear` _integer (32-bit) (optional)_ +
+**Example:** `2002` + +--- +##### `thumb` _string (optional)_ +
+**Example:** `/library/metadata/2/thumb/1705636920` + +--- +##### `art` _string (optional)_ +
+**Example:** `/library/metadata/1/art/1705636920` + +--- +##### `parentThumb` _string (optional)_ +
+**Example:** `/library/metadata/1/thumb/1705636920` + +--- +##### `parentTheme` _string (optional)_ +
+**Example:** `/library/metadata/1/theme/1705636920` + +--- +##### `addedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705636916` + +--- +##### `updatedAt` _integer (32-bit) (optional)_ +
+**Example:** `1705636920` + + diff --git a/content/types/operations/search_library_request/curl.mdx b/content/types/operations/search_library_request/curl.mdx new file mode 100644 index 0000000..d47f0d5 --- /dev/null +++ b/content/types/operations/search_library_request/curl.mdx @@ -0,0 +1,15 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ +the Id of the library to query + +--- +##### `type` _enumeration_ +Plex content type to search for + + import('/content/types/operations/type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/operations/search_library_response/curl.mdx b/content/types/operations/search_library_response/curl.mdx new file mode 100644 index 0000000..b266ef7 --- /dev/null +++ b/content/types/operations/search_library_response/curl.mdx @@ -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` _integer (32-bit)_ +HTTP response status code for this operation + +--- +##### `rawResponse` _HTTP response_ +Raw HTTP response; suitable for custom response parsing + +--- +##### `object` _object (optional)_ +The contents of the library by section and type + + import('/content/types/operations/search_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/operations/search_library_response_body/curl.mdx b/content/types/operations/search_library_response_body/curl.mdx new file mode 100644 index 0000000..65bcdf5 --- /dev/null +++ b/content/types/operations/search_library_response_body/curl.mdx @@ -0,0 +1,10 @@ +{/* Autogenerated DO NOT EDIT */} +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `mediaContainer` _object (optional)_ + + import('/content/types/operations/search_library_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} /> + + + diff --git a/content/types/operations/tag/curl.mdx b/content/types/operations/tag/curl.mdx index 5f93366..263e394 100644 --- a/content/types/operations/tag/curl.mdx +++ b/content/types/operations/tag/curl.mdx @@ -1,4 +1,4 @@ {/* Autogenerated DO NOT EDIT */} -Allowed values: `all` `unwatched` `newest` `recentlyAdded` `recentlyViewed` `onDeck` `collection` `edition` `genre` `year` `decade` `director` `actor` `country` `contentRating` `rating` `resolution` `firstCharacter` `folder` `search?type=1` +Allowed values: `all` `unwatched` `newest` `recentlyAdded` `recentlyViewed` `onDeck` `collection` `edition` `genre` `year` `decade` `director` `actor` `country` `contentRating` `rating` `resolution` `firstCharacter` `folder` diff --git a/content/types/operations/type/curl.mdx b/content/types/operations/type/curl.mdx index a7f4d22..2775ae4 100644 --- a/content/types/operations/type/curl.mdx +++ b/content/types/operations/type/curl.mdx @@ -1,4 +1,4 @@ {/* Autogenerated DO NOT EDIT */} -Allowed values: `audio` `video` `photo` +Allowed values: `1` `2` `3` `4` diff --git a/gen.yaml b/gen.yaml index 62b71b6..d21d2f0 100644 --- a/gen.yaml +++ b/gen.yaml @@ -7,7 +7,7 @@ generation: fixes: nameResolutionDec2023: false docs: - version: 0.2.0 + version: 0.2.1 defaultLanguage: go imports: option: openapi diff --git a/package.json b/package.json index 309b218..6c687d3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sdk-docs", - "version": "0.2.0", + "version": "0.2.1", "description": "Nextra docs template", "private": true, "scripts": { diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx index 5027190..16fbdaf 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_header.mdx @@ -24,5 +24,4 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx index cad2b5e..53f24be 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -24,6 +24,7 @@ curl http://10.10.10.47:32400/library/sections/528895/{{tag}} \ "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx index 1992ca0..9ad7968 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/5680.45 \ +curl http://10.10.10.47:32400/library/metadata/3927.85 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx index 73dc215..f0c9b17 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/library/metadata/3927.85/children \ +curl http://10.10.10.47:32400/library/metadata/9255.97/children \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx b/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx index dbc7380..9d9c9e1 100644 --- a/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/curl/resources/library/library_content.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/curl/library/delete_library) - Delete Library Section * [Get Library Items](/curl/library/get_library_items) - Get Library Items * [Refresh Library](/curl/library/refresh_library) - Refresh Library +* [Search Library](/curl/library/search_library) - Search Library * [Get Metadata](/curl/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children * [Get On Deck](/curl/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_authentication.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_authentication.mdx @@ -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: `` + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_header.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..54c126a --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_header.mdx @@ -0,0 +1,25 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Search Library + + + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..c5ae82f --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_parameters.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/operations/type/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _integer_ +the Id of the library to query + +--- +##### `type` _enumeration_ +Plex content type to search for + + + + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..cf771e5 --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_response.mdx @@ -0,0 +1,22 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryMediaContainer from "/content/types/operations/search_library_media_container/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'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..e2429c9 --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/_usage.mdx @@ -0,0 +1,29 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/568045/search \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4cc0965 --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library.mdx @@ -0,0 +1,6 @@ +import SearchLibrary from './search_library_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library_content.mdx b/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library_content.mdx new file mode 100644 index 0000000..d9eb087 --- /dev/null +++ b/src/.gen/pages/01-reference/curl/resources/library/search_library/search_library_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx index c08b4a6..c585a9c 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3682.41/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ +curl http://10.10.10.47:32400/playlists/8326.2/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx index fb23a7e..95a9bb1 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/202.18/items \ +curl http://10.10.10.47:32400/playlists/3682.41/items \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx index b6b73de..0033426 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import Type from "/content/types/operations/type/curl.mdx" +import QueryParamType from "/content/types/operations/query_param_type/curl.mdx" import Smart from "/content/types/operations/smart/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -12,7 +12,7 @@ name of the playlist type of playlist to create - + --- diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx index 75d9c51..f8e7afa 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists?playQueueID=9255.97&title=string&uri=string \ +curl http://10.10.10.47:32400/playlists?playQueueID=8360.79&title=string&uri=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx index 398e8d7..0ec3d63 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/710.36 \ +curl http://10.10.10.47:32400/playlists/3373.96 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx index 00e1dc3..ab6d8d7 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/8360.79 \ +curl http://10.10.10.47:32400/playlists/710.36 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx index c827cad..c3cff1a 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/871.29/items?type=6481.72 \ +curl http://10.10.10.47:32400/playlists/6481.72/items?type=202.18 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx index 32bc5cd..cda38e4 100644 --- a/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/playlists/3373.96?summary=string&title=string \ +curl http://10.10.10.47:32400/playlists/871.29?summary=string&title=string \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx index 9944de6..66ab55b 100644 --- a/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/curl/resources/security/get_transient_token/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/operations/query_param_type/curl.mdx" +import GetTransientTokenQueryParamType from "/content/types/operations/get_transient_token_query_param_type/curl.mdx" import Scope from "/content/types/operations/scope/curl.mdx" import Collapsible from "/src/components/Collapsible"; import Labels from "/src/lib/labels"; @@ -8,7 +8,7 @@ import Labels from "/src/lib/labels"; `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx index cefdf4e..9399397 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/get_timeline/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/:/timeline?context=string&duration=7206.33&hasMDE=6788.8&key=string&playBackTime=5820.2&playQueueItemID=6399.21&ratingKey=7805.29&row=1433.53&time=1182.74 \ +curl http://10.10.10.47:32400/:/timeline?context=string&duration=6399.21&hasMDE=1182.74&key=string&playBackTime=1433.53&playQueueItemID=5820.2&ratingKey=6788.8&row=5373.73&time=7206.33 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx index 5ac2ead..7f4220a 100644 --- a/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/curl/resources/video/start_universal_transcode/_usage.mdx @@ -1,7 +1,7 @@ ```bash Example Request -curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4614.79&audioBoost=7991.59&autoAdjustQuality=5204.78&directPlay=8700.88&directStream=9786.19&fastSeek=8700.13&hasMDE=9571.56&location=string&mediaBufferSize=8009.11&mediaIndex=7781.57&partIndex=1403.5&path=string&protocol=string&session=string&subtites=string&subtitleSize=4736.08 \ +curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=5204.78&audioBoost=8009.11&autoAdjustQuality=7805.29&directPlay=9786.19&directStream=4736.08&fastSeek=8700.88&hasMDE=7781.57&location=string&mediaBufferSize=4614.79&mediaIndex=1403.5&partIndex=8700.13&path=string&protocol=string&session=string&subtites=string&subtitleSize=7991.59 \ --header 'Accept: application/json' \ --header 'X-Plex-Token: YOUR_API_KEY_HERE' ``` diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx index 2d0f43a..cd6b0a3 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_library_items/_usage.mdx @@ -51,6 +51,7 @@ func main() { "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx index ecc687b..4353e1f 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_metadata/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var ratingKey float64 = 7917.25 + var ratingKey float64 = 5288.95 ctx := context.Background() res, err := s.Library.GetMetadata(ctx, ratingKey) diff --git a/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx index 54d793a..6501296 100644 --- a/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/get_metadata_children/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var ratingKey float64 = 8121.69 + var ratingKey float64 = 4799.77 ctx := context.Background() res, err := s.Library.GetMetadataChildren(ctx, ratingKey) diff --git a/src/.gen/pages/01-reference/go/resources/library/library_content.mdx b/src/.gen/pages/01-reference/go/resources/library/library_content.mdx index 6fba642..361df47 100644 --- a/src/.gen/pages/01-reference/go/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/go/resources/library/library_content.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/go/library/delete_library) - Delete Library Section * [Get Library Items](/go/library/get_library_items) - Get Library Items * [Refresh Library](/go/library/refresh_library) - Refresh Library +* [Search Library](/go/library/search_library) - Search Library * [Get Metadata](/go/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/go/library/get_metadata_children) - Get Items Children * [Get On Deck](/go/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/_header.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..e6e4f3f --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/_parameters.mdx @@ -0,0 +1,20 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/models/operations/type/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context) +The context to use for the request. + +--- +##### `sectionID` *{`int64`}* +the Id of the library to query + +--- +##### `type_` *{`operations.Type`}* +Plex content type to search for + + + + + diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/_response.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..94270bb --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/_response.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/go.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`*operations.SearchLibraryResponse`}* + + + + + + +--- +##### *{`error`}* + + diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/_usage.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..3af69a0 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/_usage.mdx @@ -0,0 +1,56 @@ + + +```go SearchLibrary.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(""), + ) + + + var sectionID int64 = 791725 + + var type_ operations.Type = operations.TypeFour + + ctx := context.Background() + res, err := s.Library.SearchLibrary(ctx, sectionID, type_) + if err != nil { + log.Fatal(err) + } + + if res.Object != nil { + // handle response + } +} +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/search_library.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4cc0965 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/search_library.mdx @@ -0,0 +1,6 @@ +import SearchLibrary from './search_library_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/go/resources/library/search_library/search_library_content.mdx b/src/.gen/pages/01-reference/go/resources/library/search_library/search_library_content.mdx new file mode 100644 index 0000000..d9eb087 --- /dev/null +++ b/src/.gen/pages/01-reference/go/resources/library/search_library/search_library_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx index eef517a..58c3201 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/add_playlist_contents/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var playlistID float64 = 1403.5 + var playlistID float64 = 8700.88 var uri string = "server://12345/com.plexapp.plugins.library/library/metadata/1" diff --git a/src/.gen/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx index fcde240..a2c502f 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/clear_playlist_contents/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 7781.57 + var playlistID float64 = 8700.13 ctx := context.Background() res, err := s.Playlists.ClearPlaylistContents(ctx, playlistID) diff --git a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx index 4e21e98..3edd0e4 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/create_playlist/_usage.mdx @@ -19,9 +19,9 @@ func main() { ctx := context.Background() res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{ Title: "string", - Type: operations.TypeVideo, + Type: operations.QueryParamTypeVideo, Smart: operations.SmartOne, - URI: "http://velvety-spiderling.com", + URI: "https://bite-sized-favorite.com", }) if err != nil { log.Fatal(err) diff --git a/src/.gen/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx index d9d5c68..14660a8 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/delete_playlist/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 202.18 + var playlistID float64 = 8326.2 ctx := context.Background() res, err := s.Playlists.DeletePlaylist(ctx, playlistID) diff --git a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx index efe3b2f..e706bf8 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist/_usage.mdx @@ -16,7 +16,7 @@ func main() { ) - var playlistID float64 = 6481.72 + var playlistID float64 = 3682.41 ctx := context.Background() res, err := s.Playlists.GetPlaylist(ctx, playlistID) diff --git a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx index e537c19..34fb82d 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/get_playlist_contents/_usage.mdx @@ -16,9 +16,9 @@ func main() { ) - var playlistID float64 = 8326.2 + var playlistID float64 = 7781.57 - var type_ float64 = 9571.56 + var type_ float64 = 1403.5 ctx := context.Background() res, err := s.Playlists.GetPlaylistContents(ctx, playlistID, type_) diff --git a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx index e85835a..2ca8bb4 100644 --- a/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/playlists/update_playlist/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var playlistID float64 = 3682.41 + var playlistID float64 = 9571.56 var title *string = "string" diff --git a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx index 94b51a7..9ac6e99 100644 --- a/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/security/get_source_connection_information/_usage.mdx @@ -17,7 +17,7 @@ func main() { ) - var source string = "provider://provider-identifier" + var source string = "server://client-identifier" ctx := context.Background() res, err := s.Security.GetSourceConnectionInformation(ctx, source) diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx index 955cf47..75f5abe 100644 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_parameters.mdx @@ -1,5 +1,5 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/go.mdx" +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"; @@ -8,11 +8,11 @@ import Labels from "/src/lib/labels"; The context to use for the request. --- -##### `type_` *{`operations.QueryParamType`}* +##### `type_` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx index 40fa91e..1d1aa9e 100644 --- a/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/security/get_transient_token/_usage.mdx @@ -18,7 +18,7 @@ func main() { ) - var type_ operations.QueryParamType = operations.QueryParamTypeDelegation + var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation var scope operations.Scope = operations.ScopeAll diff --git a/src/.gen/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx b/src/.gen/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx index a22d4b2..6c7375a 100644 --- a/src/.gen/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/updater/apply_updates/_usage.mdx @@ -18,9 +18,9 @@ func main() { ) - var tonight *operations.Tonight = operations.TonightZero + var tonight *operations.Tonight = operations.TonightOne - var skip *operations.Skip = operations.SkipOne + var skip *operations.Skip = operations.SkipZero ctx := context.Background() res, err := s.Updater.ApplyUpdates(ctx, tonight, skip) diff --git a/src/.gen/pages/01-reference/go/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/go/resources/video/get_timeline/_usage.mdx index e8f0a8c..ada86a7 100644 --- a/src/.gen/pages/01-reference/go/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/video/get_timeline/_usage.mdx @@ -19,16 +19,16 @@ func main() { ctx := context.Background() res, err := s.Video.GetTimeline(ctx, operations.GetTimelineRequest{ - RatingKey: 6788.8, + RatingKey: 7206.33, Key: "", - State: operations.StatePlaying, - HasMDE: 7206.33, - Time: 6399.21, - Duration: 5820.2, + State: operations.StatePaused, + HasMDE: 5820.2, + Time: 1433.53, + Duration: 5373.73, Context: "string", - PlayQueueItemID: 1433.53, - PlayBackTime: 5373.73, - Row: 9446.69, + PlayQueueItemID: 9446.69, + PlayBackTime: 7586.16, + Row: 5218.48, }) if err != nil { log.Fatal(err) diff --git a/src/.gen/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx index 4d40338..06c9fb1 100644 --- a/src/.gen/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/go/resources/video/start_universal_transcode/_usage.mdx @@ -19,10 +19,10 @@ func main() { ctx := context.Background() res, err := s.Video.StartUniversalTranscode(ctx, operations.StartUniversalTranscodeRequest{ - HasMDE: 8009.11, - Path: "/private", - MediaIndex: 5204.78, - PartIndex: 7805.29, + HasMDE: 5204.78, + Path: "/usr/libexec", + MediaIndex: 6788.8, + PartIndex: 1182.74, Protocol: "string", }) if err != nil { diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx index 923bcd0..610a480 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_library_items/_usage.mdx @@ -34,6 +34,7 @@ if res.object is not None: "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx index c76aad7..64102d2 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_metadata/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata(rating_key=7917.25) +res = s.library.get_metadata(rating_key=5288.95) if res.object is not None: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx index 1433ae8..2781ea4 100644 --- a/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/get_metadata_children/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.library.get_metadata_children(rating_key=8121.69) +res = s.library.get_metadata_children(rating_key=4799.77) if res.object is not None: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/library/library_content.mdx b/src/.gen/pages/01-reference/python/resources/library/library_content.mdx index e5ecced..18735b9 100644 --- a/src/.gen/pages/01-reference/python/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/python/resources/library/library_content.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/python/library/delete_library) - Delete Library Section * [Get Library Items](/python/library/get_library_items) - Get Library Items * [Refresh Library](/python/library/refresh_library) - Refresh Library +* [Search Library](/python/library/search_library) - Search Library * [Get Metadata](/python/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/python/library/get_metadata_children) - Get Items Children * [Get On Deck](/python/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/_header.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..89fea58 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/_parameters.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/models/operations/type/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `section_id` *{`int`}* +the Id of the library to query + +--- +##### `type` *{`operations.Type`}* +Plex content type to search for + + + + + diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/_response.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..0b78f23 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/python.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`operations.SearchLibraryResponse`}* + + + + + + + diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/_usage.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..57cd3e4 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/_usage.mdx @@ -0,0 +1,39 @@ + + +```python SearchLibrary.py +import plex_api +from plex_api.models import operations + +s = plex_api.PlexAPI( + access_token="", +) + + +res = s.library.search_library(section_id=791725, type=operations.Type.FOUR) + +if res.object is not None: + # handle response + pass +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/search_library.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4cc0965 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/search_library.mdx @@ -0,0 +1,6 @@ +import SearchLibrary from './search_library_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/python/resources/library/search_library/search_library_content.mdx b/src/.gen/pages/01-reference/python/resources/library/search_library/search_library_content.mdx new file mode 100644 index 0000000..d9eb087 --- /dev/null +++ b/src/.gen/pages/01-reference/python/resources/library/search_library/search_library_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx index 3946ae0..5223d52 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/add_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.add_playlist_contents(playlist_id=1403.5, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) +res = s.playlists.add_playlist_contents(playlist_id=8700.88, uri='server://12345/com.plexapp.plugins.library/library/metadata/1', play_queue_id=123) if res.object is not None: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx index 6db2dc2..9426808 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/clear_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.clear_playlist_contents(playlist_id=7781.57) +res = s.playlists.clear_playlist_contents(playlist_id=8700.13) if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx index 7145344..7b263ca 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/create_playlist/_usage.mdx @@ -10,9 +10,9 @@ s = plex_api.PlexAPI( req = operations.CreatePlaylistRequest( title='string', - type=operations.Type.VIDEO, + type=operations.QueryParamType.VIDEO, smart=operations.Smart.ONE, - uri='http://velvety-spiderling.com', + uri='https://bite-sized-favorite.com', ) res = s.playlists.create_playlist(req) diff --git a/src/.gen/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx index 4a23277..f6dffad 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/delete_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.delete_playlist(playlist_id=202.18) +res = s.playlists.delete_playlist(playlist_id=8326.2) if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx index cf53d74..a8aff64 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.get_playlist(playlist_id=6481.72) +res = s.playlists.get_playlist(playlist_id=3682.41) if res.object is not None: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx index b8c549b..2245d51 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/get_playlist_contents/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.get_playlist_contents(playlist_id=8326.2, type=9571.56) +res = s.playlists.get_playlist_contents(playlist_id=7781.57, type=1403.5) if res.object is not None: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx index 33b1607..bae2298 100644 --- a/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/playlists/update_playlist/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.playlists.update_playlist(playlist_id=3682.41, title='string', summary='string') +res = s.playlists.update_playlist(playlist_id=9571.56, title='string', summary='string') if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx index 97bcdd8..4707a44 100644 --- a/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/security/get_source_connection_information/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.security.get_source_connection_information(source='provider://provider-identifier') +res = s.security.get_source_connection_information(source='server://client-identifier') if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx index d7bccd4..05f54a2 100644 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_parameters.mdx @@ -1,14 +1,14 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/python.mdx" +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.QueryParamType`}* +##### `type` *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx index 6d33cbc..27a853c 100644 --- a/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/security/get_transient_token/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.security.get_transient_token(type=operations.QueryParamType.DELEGATION, scope=operations.Scope.ALL) +res = s.security.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx b/src/.gen/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx index 548e3e8..1ee097d 100644 --- a/src/.gen/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/updater/apply_updates/_usage.mdx @@ -9,7 +9,7 @@ s = plex_api.PlexAPI( ) -res = s.updater.apply_updates(tonight=operations.Tonight.ZERO, skip=operations.Skip.ONE) +res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ZERO) if res.status_code == 200: # handle response diff --git a/src/.gen/pages/01-reference/python/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/python/resources/video/get_timeline/_usage.mdx index 06d1b7d..c84fefc 100644 --- a/src/.gen/pages/01-reference/python/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/video/get_timeline/_usage.mdx @@ -9,16 +9,16 @@ s = plex_api.PlexAPI( ) req = operations.GetTimelineRequest( - rating_key=6788.8, + rating_key=7206.33, key='', - state=operations.State.PLAYING, - has_mde=7206.33, - time=6399.21, - duration=5820.2, + state=operations.State.PAUSED, + has_mde=5820.2, + time=1433.53, + duration=5373.73, context='string', - play_queue_item_id=1433.53, - play_back_time=5373.73, - row=9446.69, + play_queue_item_id=9446.69, + play_back_time=7586.16, + row=5218.48, ) res = s.video.get_timeline(req) diff --git a/src/.gen/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx index bcdd699..f791bbc 100644 --- a/src/.gen/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/python/resources/video/start_universal_transcode/_usage.mdx @@ -9,10 +9,10 @@ s = plex_api.PlexAPI( ) req = operations.StartUniversalTranscodeRequest( - has_mde=8009.11, - path='/private', - media_index=5204.78, - part_index=7805.29, + has_mde=5204.78, + path='/usr/libexec', + media_index=6788.8, + part_index=1182.74, protocol='string', ) diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx index 0cb92e7..e3c3a33 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_header.mdx @@ -20,4 +20,3 @@ Fetches details from a specific section of the library identified by a section k - `resolution`: Items categorized by resolution. - `firstCharacter`: Items categorized by the first letter. - `folder`: Items categorized by folder. -- `search?type=1`: Search functionality within the section. diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx index 66dea81..0968ccc 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_library_items/_usage.mdx @@ -39,6 +39,7 @@ run(); "title2": "Recently Released", "viewGroup": "movie", "viewMode": 65592, + "mixedParents": true, "Metadata": [] } } diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx index 7b72a58..b2ab5e8 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 7917.25; + const ratingKey = 5288.95; const result = await sdk.library.getMetadata(ratingKey); diff --git a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx index 5a38d26..c5f1071 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/get_metadata_children/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const ratingKey = 8121.69; + const ratingKey = 4799.77; const result = await sdk.library.getMetadataChildren(ratingKey); diff --git a/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx b/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx index 47efd43..c027ba5 100644 --- a/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/library/library_content.mdx @@ -5,6 +5,7 @@ import GetLibrary from "./get_library/get_library.mdx"; import DeleteLibrary from "./delete_library/delete_library.mdx"; import GetLibraryItems from "./get_library_items/get_library_items.mdx"; import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import SearchLibrary from "./search_library/search_library.mdx"; import GetMetadata from "./get_metadata/get_metadata.mdx"; import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; @@ -22,6 +23,7 @@ API Calls interacting with Plex Media Server Libraries * [Delete Library](/typescript/library/delete_library) - Delete Library Section * [Get Library Items](/typescript/library/get_library_items) - Get Library Items * [Refresh Library](/typescript/library/refresh_library) - Refresh Library +* [Search Library](/typescript/library/search_library) - Search Library * [Get Metadata](/typescript/library/get_metadata) - Get Items Metadata * [Get Metadata Children](/typescript/library/get_metadata_children) - Get Items Children * [Get On Deck](/typescript/library/get_on_deck) - Get On Deck @@ -47,6 +49,9 @@ API Calls interacting with Plex Media Server Libraries --- +--- + + --- diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/_header.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_header.mdx new file mode 100644 index 0000000..d1e521d --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_header.mdx @@ -0,0 +1,20 @@ +## Search Library + +Search for content within a specific section of the library. + +### Types +Each type in the library comes with a set of filters and sorts, aiding in building dynamic media controls: + +- **Type Object Attributes**: + - `type`: Metadata type (if standard Plex type). + - `title`: Title for this content type (e.g., "Movies"). + +- **Filter Objects**: + - Subset of the media query language. + - Attributes include `filter` (name), `filterType` (data type), `key` (endpoint for value range), and `title`. + +- **Sort Objects**: + - Description of sort fields. + - Attributes include `defaultDirection` (asc/desc), `descKey` and `key` (sort parameters), and `title`. + +> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx new file mode 100644 index 0000000..5d285de --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_parameters.mdx @@ -0,0 +1,24 @@ +{/* Autogenerated DO NOT EDIT */} +import TypeT from "/content/types/models/operations/type_t/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId`: *{`number`}* +the Id of the library to query + +--- +##### `type`: *{`operations.TypeT`}* +Plex content type to search for + + + + + +--- +##### `options?`: *{`RequestOptions`}* +Options for making HTTP requests. + +--- +##### `options.fetchOptions?`: [*{ `RequestInit` }*](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) +Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. + diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/_response.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_response.mdx new file mode 100644 index 0000000..4feceaf --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_response.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +import SearchLibraryResponse from "/content/types/models/operations/search_library_response/typescript.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### *{`Promise`}* + + + + + + + diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_usage.mdx new file mode 100644 index 0000000..3378364 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/_usage.mdx @@ -0,0 +1,44 @@ + + +```typescript SearchLibrary.ts +import { PlexAPI } from "@lukehagar/plexjs"; +import { TypeT } from "@lukehagar/plexjs/models/operations"; + +async function run() { + const sdk = new PlexAPI({ + accessToken: "", + }); + + const sectionId = 791725; + const type = TypeT.Four; + + const result = await sdk.library.searchLibrary(sectionId, type); + + // Handle the result + console.log(result) +} + +run(); +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 2, + "allowSync": false, + "art": "/:/resources/show-fanart.jpg", + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1698860922, + "nocache": true, + "thumb": "/:/resources/show.png", + "title1": "TV Shows", + "title2": "Search for ''", + "viewGroup": "season", + "viewMode": 65593, + "Metadata": [] + } + } +``` + diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library.mdx new file mode 100644 index 0000000..4cc0965 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library.mdx @@ -0,0 +1,6 @@ +import SearchLibrary from './search_library_content.mdx'; +import {DocsSection} from "/src/components/Section/section"; + + + + diff --git a/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library_content.mdx b/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library_content.mdx new file mode 100644 index 0000000..d9eb087 --- /dev/null +++ b/src/.gen/pages/01-reference/typescript/resources/library/search_library/search_library_content.mdx @@ -0,0 +1,21 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* rendered from operation template */} + +import {LanguageOperation} from "/content/languages"; +import Parameters from "./_parameters.mdx"; +import Response from "./_response.mdx"; +import Usage from "./_usage.mdx"; + +} response={} usage={}/> + +{/* end rendered section */} diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx index 03a7b53..cf68417 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/add_playlist_contents/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 1403.5; + const playlistID = 8700.88; const uri = "server://12345/com.plexapp.plugins.library/library/metadata/1"; const playQueueID = 123; diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx index 3f21e88..336daef 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/clear_playlist_contents/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 7781.57; + const playlistID = 8700.13; const result = await sdk.playlists.clearPlaylistContents(playlistID); diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx index 5e59556..b0f1fcc 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/create_playlist/_usage.mdx @@ -2,7 +2,7 @@ ```typescript CreatePlaylist.ts import { PlexAPI } from "@lukehagar/plexjs"; -import { Smart, TypeT } from "@lukehagar/plexjs/models/operations"; +import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ @@ -11,9 +11,9 @@ async function run() { const result = await sdk.playlists.createPlaylist({ title: "string", - type: TypeT.Video, + type: QueryParamType.Video, smart: Smart.One, - uri: "http://velvety-spiderling.com", + uri: "https://bite-sized-favorite.com", }); // Handle the result diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx index 86f91e3..d5d567a 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/delete_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 202.18; + const playlistID = 8326.2; const result = await sdk.playlists.deletePlaylist(playlistID); diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx index c9d23cb..ffe43f5 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 6481.72; + const playlistID = 3682.41; const result = await sdk.playlists.getPlaylist(playlistID); diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx index 217e38b..6fd6ff4 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/get_playlist_contents/_usage.mdx @@ -8,8 +8,8 @@ async function run() { accessToken: "", }); - const playlistID = 8326.2; - const type = 9571.56; + const playlistID = 7781.57; + const type = 1403.5; const result = await sdk.playlists.getPlaylistContents(playlistID, type); diff --git a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx index 9bcfad4..3a8749f 100644 --- a/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/playlists/update_playlist/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const playlistID = 3682.41; + const playlistID = 9571.56; const title = "string"; const summary = "string"; diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx index 493bb5d..1eedabf 100644 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/security/get_source_connection_information/_usage.mdx @@ -8,7 +8,7 @@ async function run() { accessToken: "", }); - const source = "provider://provider-identifier"; + const source = "server://client-identifier"; const result = await sdk.security.getSourceConnectionInformation(source); diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx index 761c835..f8aa661 100644 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_parameters.mdx @@ -1,14 +1,14 @@ {/* Autogenerated DO NOT EDIT */} -import QueryParamType from "/content/types/models/operations/query_param_type/typescript.mdx" +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.QueryParamType`}* +##### `type`: *{`operations.GetTransientTokenQueryParamType`}* `delegation` \- This is the only supported `type` parameter. - + --- diff --git a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx index 9546912..eda6e6f 100644 --- a/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/security/get_transient_token/_usage.mdx @@ -2,14 +2,14 @@ ```typescript GetTransientToken.ts import { PlexAPI } from "@lukehagar/plexjs"; -import { QueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; +import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations"; async function run() { const sdk = new PlexAPI({ accessToken: "", }); - const type = QueryParamType.Delegation; + const type = GetTransientTokenQueryParamType.Delegation; const scope = Scope.All; const result = await sdk.security.getTransientToken(type, scope); diff --git a/src/.gen/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx index 87bed03..89be554 100644 --- a/src/.gen/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/updater/apply_updates/_usage.mdx @@ -9,8 +9,8 @@ async function run() { accessToken: "", }); - const tonight = Tonight.Zero; - const skip = Skip.One; + const tonight = Tonight.One; + const skip = Skip.Zero; const result = await sdk.updater.applyUpdates(tonight, skip); diff --git a/src/.gen/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx index 27fb38e..8b7e5e3 100644 --- a/src/.gen/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/video/get_timeline/_usage.mdx @@ -10,16 +10,16 @@ async function run() { }); const result = await sdk.video.getTimeline({ - ratingKey: 6788.8, + ratingKey: 7206.33, key: "", - state: State.Playing, - hasMDE: 7206.33, - time: 6399.21, - duration: 5820.2, + state: State.Paused, + hasMDE: 5820.2, + time: 1433.53, + duration: 5373.73, context: "string", - playQueueItemID: 1433.53, - playBackTime: 5373.73, - row: 9446.69, + playQueueItemID: 9446.69, + playBackTime: 7586.16, + row: 5218.48, }); // Handle the result diff --git a/src/.gen/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx b/src/.gen/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx index 48b87e8..478374c 100644 --- a/src/.gen/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx +++ b/src/.gen/pages/01-reference/typescript/resources/video/start_universal_transcode/_usage.mdx @@ -9,10 +9,10 @@ async function run() { }); const result = await sdk.video.startUniversalTranscode({ - hasMDE: 8009.11, - path: "/private", - mediaIndex: 5204.78, - partIndex: 7805.29, + hasMDE: 5204.78, + path: "/usr/libexec", + mediaIndex: 6788.8, + partIndex: 1182.74, protocol: "string", }); diff --git a/src/pages/curl/library/_meta.json b/src/pages/curl/library/_meta.json index b0a6dbe..fe7b636 100644 --- a/src/pages/curl/library/_meta.json +++ b/src/pages/curl/library/_meta.json @@ -1,13 +1,12 @@ { - "delete_library": "Delete Library", - "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", - "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", + "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", + "search_library": "Search Library", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/curl/library/get_common_library_items/_meta.json b/src/pages/curl/library/search_library/_meta.json similarity index 100% rename from src/pages/curl/library/get_common_library_items/_meta.json rename to src/pages/curl/library/search_library/_meta.json diff --git a/src/pages/go/library/_meta.json b/src/pages/go/library/_meta.json index b0a6dbe..fe7b636 100644 --- a/src/pages/go/library/_meta.json +++ b/src/pages/go/library/_meta.json @@ -1,13 +1,12 @@ { - "delete_library": "Delete Library", - "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", - "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", + "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", + "search_library": "Search Library", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/curl/library/get_latest_library_items/_meta.json b/src/pages/go/library/search_library/_meta.json similarity index 100% rename from src/pages/curl/library/get_latest_library_items/_meta.json rename to src/pages/go/library/search_library/_meta.json diff --git a/src/pages/python/library/_meta.json b/src/pages/python/library/_meta.json index b0a6dbe..fe7b636 100644 --- a/src/pages/python/library/_meta.json +++ b/src/pages/python/library/_meta.json @@ -1,13 +1,12 @@ { - "delete_library": "Delete Library", - "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", - "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", + "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", + "search_library": "Search Library", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/python/library/get_common_library_items/_meta.json b/src/pages/python/library/get_common_library_items/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/python/library/get_common_library_items/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/python/library/get_latest_library_items/_meta.json b/src/pages/python/library/get_latest_library_items/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/python/library/get_latest_library_items/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/go/library/get_common_library_items/_meta.json b/src/pages/python/library/search_library/_meta.json similarity index 100% rename from src/pages/go/library/get_common_library_items/_meta.json rename to src/pages/python/library/search_library/_meta.json diff --git a/src/pages/typescript/library/_meta.json b/src/pages/typescript/library/_meta.json index b0a6dbe..fe7b636 100644 --- a/src/pages/typescript/library/_meta.json +++ b/src/pages/typescript/library/_meta.json @@ -1,13 +1,12 @@ { - "delete_library": "Delete Library", - "get_common_library_items": "Get Common Library Items", "get_file_hash": "Get File Hash", - "get_latest_library_items": "Get Latest Library Items", "get_recently_added": "Get Recently Added", "get_libraries": "Get Libraries", "get_library": "Get Library", + "delete_library": "Delete Library", "get_library_items": "Get Library Items", "refresh_library": "Refresh Library", + "search_library": "Search Library", "get_metadata": "Get Metadata", "get_metadata_children": "Get Metadata Children", "get_on_deck": "Get On Deck" diff --git a/src/pages/typescript/library/get_common_library_items/_meta.json b/src/pages/typescript/library/get_common_library_items/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/typescript/library/get_common_library_items/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/typescript/library/get_latest_library_items/_meta.json b/src/pages/typescript/library/get_latest_library_items/_meta.json deleted file mode 100644 index 9e26dfe..0000000 --- a/src/pages/typescript/library/get_latest_library_items/_meta.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/src/pages/go/library/get_latest_library_items/_meta.json b/src/pages/typescript/library/search_library/_meta.json similarity index 100% rename from src/pages/go/library/get_latest_library_items/_meta.json rename to src/pages/typescript/library/search_library/_meta.json