LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-09 20:47:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.151.0

Browse Source
This commit is contained in:
speakeasybot
2024-01-24 00:32:49 +00:00
parent e044084015
commit 64a942a910
254 changed files with 2806 additions and 356 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/types/operations/create_playlist_request/curl.mdx
View File

@@ -9,7 +9,7 @@ name of the playlist
##### `type` _enumeration_
type of playlist to create
<Collapsible content={() => import('/content/types/operations/type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
<Collapsible content={() => import('/content/types/operations/query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---

7
content/types/operations/get_library_items_media_container/curl.mdx
View File

@@ -68,9 +68,14 @@
<br/>
**Example:** `65592`
---
##### `mixedParents` _boolean (optional)_
<br/>
**Example:** `true`
---
##### `metadata` _array (optional)_
<br/>
**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}]`

115
content/types/operations/get_library_items_metadata/curl.mdx
View File

@@ -108,6 +108,41 @@
<br/>
**Example:** `rottentomatoes://image.rating.ripe`
---
##### `grandparentRatingKey` _string (optional)_
<br/>
**Example:** `66`
---
##### `grandparentGuid` _string (optional)_
<br/>
**Example:** `plex://show/5d9c081b170e24001f2a7be4`
---
##### `grandparentKey` _string (optional)_
<br/>
**Example:** `/library/metadata/66`
---
##### `grandparentTitle` _string (optional)_
<br/>
**Example:** `Caprica`
---
##### `grandparentThumb` _string (optional)_
<br/>
**Example:** `/library/metadata/66/thumb/1705716261`
---
##### `grandparentArt` _string (optional)_
<br/>
**Example:** `/library/metadata/66/art/1705716261`
---
##### `grandparentTheme` _string (optional)_
<br/>
**Example:** `/library/metadata/66/theme/1705716261`
---
##### `media` _array (optional)_
<br/>
@@ -168,4 +203,84 @@
<br/>
**Example:** `1`
---
##### `index` _integer (32-bit) (optional)_
<br/>
**Example:** `1`
---
##### `theme` _string (optional)_
<br/>
**Example:** `/library/metadata/1/theme/1705636920`
---
##### `leafCount` _integer (32-bit) (optional)_
<br/>
**Example:** `14`
---
##### `viewedLeafCount` _integer (32-bit) (optional)_
<br/>
**Example:** `0`
---
##### `childCount` _integer (32-bit) (optional)_
<br/>
**Example:** `1`
---
##### `hasPremiumExtras` _string (optional)_
<br/>
**Example:** `1`
---
##### `hasPremiumPrimaryExtra` _string (optional)_
<br/>
**Example:** `1`
---
##### `parentRatingKey` _string (optional)_
<br/>
**Example:** `66`
---
##### `parentGuid` _string (optional)_
<br/>
**Example:** `plex://show/5d9c081b170e24001f2a7be4`
---
##### `parentStudio` _string (optional)_
<br/>
**Example:** `UCP`
---
##### `parentKey` _string (optional)_
<br/>
**Example:** `/library/metadata/66`
---
##### `parentTitle` _string (optional)_
<br/>
**Example:** `Caprica`
---
##### `parentIndex` _integer (32-bit) (optional)_
<br/>
**Example:** `1`
---
##### `parentYear` _integer (32-bit) (optional)_
<br/>
**Example:** `2010`
---
##### `parentThumb` _string (optional)_
<br/>
**Example:** `/library/metadata/66/thumb/1705716261`
---
##### `parentTheme` _string (optional)_
<br/>
**Example:** `/library/metadata/66/theme/1705716261`

4
content/types/operations/get_transient_token_query_param_type/curl.mdx Normal file
View File

@@ -0,0 +1,4 @@
{/* Autogenerated DO NOT EDIT */}
Allowed values: `delegation`

2
content/types/operations/get_transient_token_request/curl.mdx
View File

@@ -5,7 +5,7 @@ import Labels from "/src/lib/labels";
##### `type` _enumeration_
`delegation` \- This is the only supported `type` parameter.
<Collapsible content={() => import('/content/types/operations/query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
<Collapsible content={() => import('/content/types/operations/get_transient_token_query_param_type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />
---

2
content/types/operations/query_param_type/curl.mdx
View File

@@ -1,4 +1,4 @@
{/* Autogenerated DO NOT EDIT */}
Allowed values: `delegation`
Allowed values: `audio` `video` `photo`

66
content/types/operations/search_library_media_container/curl.mdx Normal file
View File

@@ -0,0 +1,66 @@
{/* Autogenerated DO NOT EDIT */}
##### `size` _integer (32-bit) (optional)_
<br/>
**Example:** `2`
---
##### `allowSync` _boolean (optional)_
<br/>
**Example:** `false`
---
##### `art` _string (optional)_
<br/>
**Example:** `/:/resources/show-fanart.jpg`
---
##### `identifier` _string (optional)_
<br/>
**Example:** `com.plexapp.plugins.library`
---
##### `mediaTagPrefix` _string (optional)_
<br/>
**Example:** `/system/bundle/media/flags/`
---
##### `mediaTagVersion` _integer (32-bit) (optional)_
<br/>
**Example:** `1698860922`
---
##### `nocache` _boolean (optional)_
<br/>
**Example:** `true`
---
##### `thumb` _string (optional)_
<br/>
**Example:** `/:/resources/show.png`
---
##### `title1` _string (optional)_
<br/>
**Example:** `TV Shows`
---
##### `title2` _string (optional)_
<br/>
**Example:** `Search for ''`
---
##### `viewGroup` _string (optional)_
<br/>
**Example:** `season`
---
##### `viewMode` _integer (32-bit) (optional)_
<br/>
**Example:** `65593`
---
##### `metadata` _array (optional)_
<br/>
**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}]`

101
content/types/operations/search_library_metadata/curl.mdx Normal file
View File

@@ -0,0 +1,101 @@
{/* Autogenerated DO NOT EDIT */}
##### `ratingKey` _string (optional)_
<br/>
**Example:** `2`
---
##### `key` _string (optional)_
<br/>
**Example:** `/library/metadata/2/children`
---
##### `parentRatingKey` _string (optional)_
<br/>
**Example:** `1`
---
##### `guid` _string (optional)_
<br/>
**Example:** `plex://season/602e67e766dfdb002c0a1b5b`
---
##### `parentGuid` _string (optional)_
<br/>
**Example:** `plex://show/5d9c086c7d06d9001ffd27aa`
---
##### `parentStudio` _string (optional)_
<br/>
**Example:** `Mutant Enemy Productions`
---
##### `type` _string (optional)_
<br/>
**Example:** `season`
---
##### `title` _string (optional)_
<br/>
**Example:** `Season 1`
---
##### `parentKey` _string (optional)_
<br/>
**Example:** `/library/metadata/1`
---
##### `parentTitle` _string (optional)_
<br/>
**Example:** `Firefly`
---
##### `summary` _string (optional)_
<br/>
**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)_
<br/>
**Example:** `1`
---
##### `parentIndex` _integer (32-bit) (optional)_
<br/>
**Example:** `1`
---
##### `parentYear` _integer (32-bit) (optional)_
<br/>
**Example:** `2002`
---
##### `thumb` _string (optional)_
<br/>
**Example:** `/library/metadata/2/thumb/1705636920`
---
##### `art` _string (optional)_
<br/>
**Example:** `/library/metadata/1/art/1705636920`
---
##### `parentThumb` _string (optional)_
<br/>
**Example:** `/library/metadata/1/thumb/1705636920`
---
##### `parentTheme` _string (optional)_
<br/>
**Example:** `/library/metadata/1/theme/1705636920`
---
##### `addedAt` _integer (32-bit) (optional)_
<br/>
**Example:** `1705636916`
---
##### `updatedAt` _integer (32-bit) (optional)_
<br/>
**Example:** `1705636920`

15
content/types/operations/search_library_request/curl.mdx Normal file
View File

@@ -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
<Collapsible content={() => import('/content/types/operations/type/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

23
content/types/operations/search_library_response/curl.mdx Normal file
View File

@@ -0,0 +1,23 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `contentType` _string_
HTTP response content type for this operation
---
##### `statusCode` _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
<Collapsible content={() => import('/content/types/operations/search_library_response_body/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

10
content/types/operations/search_library_response_body/curl.mdx Normal file
View File

@@ -0,0 +1,10 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `mediaContainer` _object (optional)_
<Collapsible content={() => import('/content/types/operations/search_library_media_container/curl.mdx')} openLabel={Labels.showProperties} closeLabel={Labels.hideProperties} />

2
content/types/operations/tag/curl.mdx
View File

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

2
content/types/operations/type/curl.mdx
View File

@@ -1,4 +1,4 @@
{/* Autogenerated DO NOT EDIT */}
Allowed values: `audio` `video` `photo`
Allowed values: `1` `2` `3` `4`