mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1cfc2d604f |
File diff suppressed because one or more lines are too long
@@ -13,7 +13,7 @@ generation:
|
|||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
go:
|
go:
|
||||||
version: 0.18.1
|
version: 0.19.0
|
||||||
additionalDependencies: {}
|
additionalDependencies: {}
|
||||||
allowUnknownFieldsInWeakUnions: false
|
allowUnknownFieldsInWeakUnions: false
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.487.1
|
speakeasyVersion: 1.488.0
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,19 +9,19 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
||||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1738973347
|
- speakeasy-sdk-regen-1739232555
|
||||||
targets:
|
targets:
|
||||||
plexgo:
|
plexgo:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
|
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
||||||
sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
|
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
||||||
codeSamplesNamespace: code-samples-go-plexgo
|
codeSamplesNamespace: code-samples-go-plexgo
|
||||||
codeSamplesRevisionDigest: sha256:79055da36c8f5a3f632269f44d4d929f9bdfae63fb53068afcbeef5e6eecb8c0
|
codeSamplesRevisionDigest: sha256:96b23ddcc80db35c9852b114146c3be99c47b4375338f8d605199a53c0498cc8
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
@@ -142,6 +142,7 @@ func main() {
|
|||||||
* [GetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [GetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [DeleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [DeleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [GetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [GetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
|
* [GetAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||||
* [GetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [GetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [GetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [GetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
* [GetGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
* [GetGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
|
|||||||
10
RELEASES.md
10
RELEASES.md
@@ -1043,3 +1043,13 @@ Based on:
|
|||||||
- [go v0.18.1] .
|
- [go v0.18.1] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Go v0.18.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.18.1 - .
|
- [Go v0.18.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.18.1 - .
|
||||||
|
|
||||||
|
## 2025-02-11 00:09:00
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.488.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.19.0] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.19.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.19.0 - .
|
||||||
@@ -237,6 +237,12 @@ actions:
|
|||||||
- lang: go
|
- lang: go
|
||||||
label: library
|
label: library
|
||||||
source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/LukeHagar/plexgo\"\n\t\"github.com/LukeHagar/plexgo/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n \n s := plexgo.New(\n plexgo.WithSecurity(\"<YOUR_API_KEY_HERE>\"),\n )\n\n res, err := s.Library.GetActorsLibrary(ctx, 9518, operations.GetActorsLibraryQueryParamTypeTvShow)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}"
|
source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/LukeHagar/plexgo\"\n\t\"github.com/LukeHagar/plexgo/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n \n s := plexgo.New(\n plexgo.WithSecurity(\"<YOUR_API_KEY_HERE>\"),\n )\n\n res, err := s.Library.GetActorsLibrary(ctx, 9518, operations.GetActorsLibraryQueryParamTypeTvShow)\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}"
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: go
|
||||||
|
label: library
|
||||||
|
source: "package main\n\nimport(\n\t\"context\"\n\t\"github.com/LukeHagar/plexgo\"\n\t\"github.com/LukeHagar/plexgo/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n \n s := plexgo.New(\n plexgo.WithSecurity(\"<YOUR_API_KEY_HERE>\"),\n )\n\n res, err := s.Library.GetAllMediaLibrary(ctx, operations.GetAllMediaLibraryRequest{\n SectionKey: 9518,\n Type: operations.GetAllMediaLibraryQueryParamTypeTvShow,\n })\n if err != nil {\n log.Fatal(err)\n }\n if res.Object != nil {\n // handle response\n }\n}"
|
||||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A | 50 |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
|||||||
12
docs/models/operations/getallmedialibraryactivedirection.md
Normal file
12
docs/models/operations/getallmedialibraryactivedirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------------------------------------------- | --------------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryActiveDirectionAscending` | asc |
|
||||||
|
| `GetAllMediaLibraryActiveDirectionDescending` | desc |
|
||||||
8
docs/models/operations/getallmedialibrarycollection.md
Normal file
8
docs/models/operations/getallmedialibrarycollection.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryCollection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
8
docs/models/operations/getallmedialibrarycountry.md
Normal file
8
docs/models/operations/getallmedialibrarycountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
12
docs/models/operations/getallmedialibrarydefaultdirection.md
Normal file
12
docs/models/operations/getallmedialibrarydefaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------------------------- | ---------------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryDefaultDirectionAscending` | asc |
|
||||||
|
| `GetAllMediaLibraryDefaultDirectionDescending` | desc |
|
||||||
8
docs/models/operations/getallmedialibrarydirector.md
Normal file
8
docs/models/operations/getallmedialibrarydirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
11
docs/models/operations/getallmedialibraryfield.md
Normal file
11
docs/models/operations/getallmedialibraryfield.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `SubType` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||||
9
docs/models/operations/getallmedialibraryfieldtype.md
Normal file
9
docs/models/operations/getallmedialibraryfieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllMediaLibraryFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `Operator` | [][operations.GetAllMediaLibraryOperator](../../models/operations/getallmedialibraryoperator.md) | :heavy_check_mark: | N/A | |
|
||||||
13
docs/models/operations/getallmedialibraryfilter.md
Normal file
13
docs/models/operations/getallmedialibraryfilter.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetAllMediaLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Advanced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
8
docs/models/operations/getallmedialibrarygenre.md
Normal file
8
docs/models/operations/getallmedialibrarygenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
11
docs/models/operations/getallmedialibraryhasthumbnail.md
Normal file
11
docs/models/operations/getallmedialibraryhasthumbnail.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------- | ------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryHasThumbnailFalse` | 0 |
|
||||||
|
| `GetAllMediaLibraryHasThumbnailTrue` | 1 |
|
||||||
10
docs/models/operations/getallmedialibraryimage.md
Normal file
10
docs/models/operations/getallmedialibraryimage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `Type` | [operations.GetAllMediaLibraryLibraryResponseType](../../models/operations/getallmedialibrarylibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `URL` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### GetAllMediaLibraryOptimizedForStreaming1
|
||||||
|
|
||||||
|
```go
|
||||||
|
getAllMediaLibraryLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryLibraryOptimizedForStreamingGetAllMediaLibraryOptimizedForStreaming1(operations.GetAllMediaLibraryOptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getAllMediaLibraryLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryLibraryOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryLibraryResponseTypeCoverPoster` | coverPoster |
|
||||||
|
| `GetAllMediaLibraryLibraryResponseTypeBackground` | background |
|
||||||
|
| `GetAllMediaLibraryLibraryResponseTypeSnapshot` | snapshot |
|
||||||
|
| `GetAllMediaLibraryLibraryResponseTypeClearLogo` | clearLogo |
|
||||||
16
docs/models/operations/getallmedialibrarylibrarytype.md
Normal file
16
docs/models/operations/getallmedialibrarylibrarytype.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetAllMediaLibraryLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------- | -------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeMovie` | movie |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeTvShow` | show |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeSeason` | season |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeEpisode` | episode |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeArtist` | artist |
|
||||||
|
| `GetAllMediaLibraryLibraryTypeAlbum` | album |
|
||||||
26
docs/models/operations/getallmedialibrarymedia.md
Normal file
26
docs/models/operations/getallmedialibrarymedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetAllMediaLibraryMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
|
| `Width` | **int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
|
| `Height` | **int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
|
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
|
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
|
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
|
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
|
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
|
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetAllMediaLibraryOptimizedForStreaming](../../models/operations/getallmedialibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `Part` | [][operations.GetAllMediaLibraryPart](../../models/operations/getallmedialibrarypart.md) | :heavy_check_mark: | An array of parts for this media item. | |
|
||||||
26
docs/models/operations/getallmedialibrarymediacontainer.md
Normal file
26
docs/models/operations/getallmedialibrarymediacontainer.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetAllMediaLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `TotalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
|
| `Offset` | *int64* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||||
|
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||||
|
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `Meta` | [*operations.GetAllMediaLibraryMeta](../../models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
|
| `Metadata` | [][operations.GetAllMediaLibraryMetadata](../../models/operations/getallmedialibrarymetadata.md) | :heavy_minus_sign: | An array of metadata items. | |
|
||||||
12
docs/models/operations/getallmedialibrarymeta.md
Normal file
12
docs/models/operations/getallmedialibrarymeta.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryMeta
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Type` | [][operations.GetAllMediaLibraryType](../../models/operations/getallmedialibrarytype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `FieldType` | [][operations.GetAllMediaLibraryFieldType](../../models/operations/getallmedialibraryfieldtype.md) | :heavy_minus_sign: | N/A |
|
||||||
74
docs/models/operations/getallmedialibrarymetadata.md
Normal file
74
docs/models/operations/getallmedialibrarymetadata.md
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
# GetAllMediaLibraryMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
|
| `GUID` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
|
| `Slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
|
| `Studio` | **string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
|
| `Type` | [operations.GetAllMediaLibraryLibraryType](../../models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
|
| `TitleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
|
| `ContentRating` | **string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
|
| `Summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||||
|
| `Rating` | *float32* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
|
| `AudienceRating` | *float64* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
|
| `Year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
|
||||||
|
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
|
| `Thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
|
| `Art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
|
| `Theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
|
| `Index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
|
| `LeafCount` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
|
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
|
| `ChildCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
|
| `SeasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
|
| `Duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
|
| `OriginallyAvailableAt` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||||
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
|
| `ChapterSource` | **string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
|
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
|
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
|
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
|
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `GrandparentGUID` | **string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `GrandparentSlug` | **string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
|
| `GrandparentKey` | **string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
|
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `GrandparentTheme` | **string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `GrandparentArt` | **string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
|
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
|
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
|
| `ParentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
|
| `ViewCount` | **int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
|
| `ViewOffset` | **int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
|
| `SkipCount` | **int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
|
| `Subtype` | **string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||||
|
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
|
| `CreatedAtAccuracy` | **string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||||
|
| `CreatedAtTZOffset` | **string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
|
| `LastViewedAt` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
|
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
|
| `Image` | [][operations.GetAllMediaLibraryImage](../../models/operations/getallmedialibraryimage.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `UltraBlurColors` | [*operations.GetAllMediaLibraryUltraBlurColors](../../models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Media` | [][operations.GetAllMediaLibraryMedia](../../models/operations/getallmedialibrarymedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Genre` | [][operations.GetAllMediaLibraryGenre](../../models/operations/getallmedialibrarygenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Country` | [][operations.GetAllMediaLibraryCountry](../../models/operations/getallmedialibrarycountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Director` | [][operations.GetAllMediaLibraryDirector](../../models/operations/getallmedialibrarydirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Writer` | [][operations.GetAllMediaLibraryWriter](../../models/operations/getallmedialibrarywriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Role` | [][operations.GetAllMediaLibraryRole](../../models/operations/getallmedialibraryrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Collection` | [][operations.GetAllMediaLibraryCollection](../../models/operations/getallmedialibrarycollection.md) | :heavy_minus_sign: | N/A | |
|
||||||
9
docs/models/operations/getallmedialibraryoperator.md
Normal file
9
docs/models/operations/getallmedialibraryoperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllMediaLibraryOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### One
|
||||||
|
|
||||||
|
```go
|
||||||
|
getAllMediaLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryOptimizedForStreamingOne(operations.One{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getAllMediaLibraryOptimizedForStreaming := operations.CreateGetAllMediaLibraryOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------------------------- | ---------------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryOptimizedForStreaming1Zero` | 0 |
|
||||||
|
| `GetAllMediaLibraryOptimizedForStreaming1One` | 1 |
|
||||||
23
docs/models/operations/getallmedialibrarypart.md
Normal file
23
docs/models/operations/getallmedialibrarypart.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetAllMediaLibraryPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
|
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `Size` | *int64* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
|
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetAllMediaLibraryLibraryOptimizedForStreaming](../../models/operations/getallmedialibrarylibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `HasThumbnail` | [*operations.GetAllMediaLibraryHasThumbnail](../../models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Stream` | [][operations.GetAllMediaLibraryStream](../../models/operations/getallmedialibrarystream.md) | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryQueryParamIncludeMeta
|
||||||
|
|
||||||
|
Adds the Meta object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------------ | ------------------------------------------------ |
|
||||||
|
| `GetAllMediaLibraryQueryParamIncludeMetaDisable` | 0 |
|
||||||
|
| `GetAllMediaLibraryQueryParamIncludeMetaEnable` | 1 |
|
||||||
22
docs/models/operations/getallmedialibraryqueryparamtype.md
Normal file
22
docs/models/operations/getallmedialibraryqueryparamtype.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetAllMediaLibraryQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------------------------------------- | ----------------------------------------- |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeMovie` | 1 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeTvShow` | 2 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeSeason` | 3 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeEpisode` | 4 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeAudio` | 8 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeAlbum` | 9 |
|
||||||
|
| `GetAllMediaLibraryQueryParamTypeTrack` | 10 |
|
||||||
16
docs/models/operations/getallmedialibraryrequest.md
Normal file
16
docs/models/operations/getallmedialibraryrequest.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetAllMediaLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
|
| `Type` | [operations.GetAllMediaLibraryQueryParamType](../../models/operations/getallmedialibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
|
| `IncludeMeta` | [*operations.GetAllMediaLibraryQueryParamIncludeMeta](../../models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
|
| `IncludeGuids` | [*operations.QueryParamIncludeGuids](../../models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||||
|
| `IncludeAdvanced` | [*operations.IncludeAdvanced](../../models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `IncludeCollections` | [*operations.QueryParamIncludeCollections](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `IncludeExternalMedia` | [*operations.QueryParamIncludeExternalMedia](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `XPlexContainerStart` | **int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
| `XPlexContainerSize` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
11
docs/models/operations/getallmedialibraryresponse.md
Normal file
11
docs/models/operations/getallmedialibraryresponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
|
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
|
| `Object` | [*operations.GetAllMediaLibraryResponseBody](../../models/operations/getallmedialibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/getallmedialibraryresponsebody.md
Normal file
10
docs/models/operations/getallmedialibraryresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `MediaContainer` | [*operations.GetAllMediaLibraryMediaContainer](../../models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/getallmedialibraryrole.md
Normal file
8
docs/models/operations/getallmedialibraryrole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||||
15
docs/models/operations/getallmedialibrarysort.md
Normal file
15
docs/models/operations/getallmedialibrarysort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetAllMediaLibrarySort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `ActiveDirection` | [*operations.GetAllMediaLibraryActiveDirection](../../models/operations/getallmedialibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DefaultDirection` | [*operations.GetAllMediaLibraryDefaultDirection](../../models/operations/getallmedialibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `FirstCharacterKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||||
54
docs/models/operations/getallmedialibrarystream.md
Normal file
54
docs/models/operations/getallmedialibrarystream.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# GetAllMediaLibraryStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
|
| `StreamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||||
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
|
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
|
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
|
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||||
|
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||||
|
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||||
|
| `HeaderCompression` | **bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
|
| `DOVIBLCompatID` | **int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
|
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
|
| `DOVIELPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
|
| `DOVILevel` | **int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
|
| `DOVIPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
|
| `DOVIProfile` | **int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
|
| `DOVIRPUPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
|
| `DOVIVersion` | **string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
|
| `BitDepth` | **int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
|
| `ChromaLocation` | **string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
|
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
|
| `CodedHeight` | **int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
|
| `CodedWidth` | **int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
|
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
|
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
|
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
|
| `ColorTrc` | **string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
|
| `FrameRate` | **float32* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
|
| `Height` | **int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
|
| `Level` | **int* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
|
| `Original` | **bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
|
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
|
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
|
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
|
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
|
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `Channels` | **int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
|
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
|
| `SamplingRate` | **int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
|
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
|
| `HearingImpaired` | **bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
|
| `Dub` | **bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
| `Title` | **string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
15
docs/models/operations/getallmedialibrarytype.md
Normal file
15
docs/models/operations/getallmedialibrarytype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetAllMediaLibraryType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Subtype` | **string* | :heavy_minus_sign: | N/A | clip |
|
||||||
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `Filter` | [][operations.GetAllMediaLibraryFilter](../../models/operations/getallmedialibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Sort` | [][operations.GetAllMediaLibrarySort](../../models/operations/getallmedialibrarysort.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Field` | [][operations.GetAllMediaLibraryField](../../models/operations/getallmedialibraryfield.md) | :heavy_minus_sign: | N/A | |
|
||||||
11
docs/models/operations/getallmedialibraryultrablurcolors.md
Normal file
11
docs/models/operations/getallmedialibraryultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `TopLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||||
|
| `TopRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
|
| `BottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||||
|
| `BottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
8
docs/models/operations/getallmedialibrarywriter.md
Normal file
8
docs/models/operations/getallmedialibrarywriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
||||||
@@ -5,18 +5,16 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A | 50 |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `Offset` | **int* | :heavy_minus_sign: | N/A | |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `TotalSize` | **int* | :heavy_minus_sign: | N/A | |
|
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | N/A | 1734362201 |
|
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `Nocache` | *bool* | :heavy_check_mark: | N/A | true |
|
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `Title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `Title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
|
||||||
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `Directory` | [][operations.GetCountriesLibraryDirectory](../../models/operations/getcountrieslibrarydirectory.md) | :heavy_minus_sign: | N/A | |
|
| `Directory` | [][operations.GetCountriesLibraryDirectory](../../models/operations/getcountrieslibrarydirectory.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -5,18 +5,16 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A | 50 |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `Offset` | **int* | :heavy_minus_sign: | N/A | |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `TotalSize` | **int* | :heavy_minus_sign: | N/A | |
|
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | N/A | 1734362201 |
|
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `Nocache` | *bool* | :heavy_check_mark: | N/A | true |
|
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `Title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `Title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
|
||||||
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `Directory` | [][operations.GetGenresLibraryDirectory](../../models/operations/getgenreslibrarydirectory.md) | :heavy_minus_sign: | N/A | |
|
| `Directory` | [][operations.GetGenresLibraryDirectory](../../models/operations/getgenreslibrarydirectory.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -10,3 +10,4 @@
|
|||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Advanced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
@@ -12,3 +12,5 @@ The type of media content
|
|||||||
| `GetLibraryItemsLibraryTypeTvShow` | show |
|
| `GetLibraryItemsLibraryTypeTvShow` | show |
|
||||||
| `GetLibraryItemsLibraryTypeSeason` | season |
|
| `GetLibraryItemsLibraryTypeSeason` | season |
|
||||||
| `GetLibraryItemsLibraryTypeEpisode` | episode |
|
| `GetLibraryItemsLibraryTypeEpisode` | episode |
|
||||||
|
| `GetLibraryItemsLibraryTypeArtist` | artist |
|
||||||
|
| `GetLibraryItemsLibraryTypeAlbum` | album |
|
||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Subtype` | **string* | :heavy_minus_sign: | N/A | clip |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
|||||||
@@ -5,6 +5,6 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
| `ID` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||||
| `Filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
| `Filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||||
| `Tag` | *string* | :heavy_check_mark: | The country name. | United States of America |
|
| `Tag` | *string* | :heavy_check_mark: | The country name. | United States of America |
|
||||||
8
docs/models/operations/getmediametadataguids.md
Normal file
8
docs/models/operations/getmediametadataguids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaMetaDataGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `ID` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||||
11
docs/models/operations/getmediametadatahasthumbnail.md
Normal file
11
docs/models/operations/getmediametadatahasthumbnail.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ----------------------------------- | ----------------------------------- |
|
||||||
|
| `GetMediaMetaDataHasThumbnailFalse` | 0 |
|
||||||
|
| `GetMediaMetaDataHasThumbnailTrue` | 1 |
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetMediaMetaDataLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### GetMediaMetaDataOptimizedForStreaming1
|
||||||
|
|
||||||
|
```go
|
||||||
|
getMediaMetaDataLibraryOptimizedForStreaming := operations.CreateGetMediaMetaDataLibraryOptimizedForStreamingGetMediaMetaDataOptimizedForStreaming1(operations.GetMediaMetaDataOptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getMediaMetaDataLibraryOptimizedForStreaming := operations.CreateGetMediaMetaDataLibraryOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -4,19 +4,23 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `Duration` | *int64* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `Bitrate` | *int64* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `Width` | *int64* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
| `Width` | **int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `Height` | *int64* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
| `Height` | **int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `AspectRatio` | *float32* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `AudioChannels` | *int64* | :heavy_check_mark: | Number of audio channels. | 6 |
|
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `AudioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
|
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `VideoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
|
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
| `VideoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `Container` | *string* | :heavy_check_mark: | File container type. | mkv |
|
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `VideoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
| `VideoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataOptimizedForStreaming](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `Part` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_check_mark: | An array of parts for this media item. | |
|
| `Part` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_check_mark: | An array of parts for this media item. | |
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A | 50 |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||||
|
|||||||
@@ -23,30 +23,32 @@
|
|||||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The ID of the library section. | 2 |
|
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||||
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||||
| `ContentRating` | *string* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
|
| `ContentRating` | **string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
|
||||||
| `Summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
| `Summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
||||||
| `Index` | **int64* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
| `Index` | **int64* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||||
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||||
| `AudienceRating` | *float32* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
|
| `AudienceRating` | **float32* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
|
||||||
| `ViewCount` | **int64* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
| `ViewCount` | **int64* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||||
| `SkipCount` | **int64* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
| `SkipCount` | **int64* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||||
| `LastViewedAt` | **int64* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
| `LastViewedAt` | **int64* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||||
| `Year` | *int64* | :heavy_check_mark: | The release year. | 2015 |
|
| `Year` | *int* | :heavy_check_mark: | The release year. | 2015 |
|
||||||
|
| `Rating` | **float32* | :heavy_minus_sign: | The general rating | 6 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
|
||||||
| `Tagline` | **string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
| `Tagline` | **string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||||
| `Thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
| `Thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||||
| `Art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
| `Art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||||
| `Theme` | **string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
| `Theme` | **string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||||
| `Duration` | *int64* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
| `Duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||||
| `OriginallyAvailableAt` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date. | 2015-02-08 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
|
||||||
| `LeafCount` | **int64* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
| `LeafCount` | **int64* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||||
| `ViewedLeafCount` | **int64* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
| `ViewedLeafCount` | **int64* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||||
| `ChildCount` | **int64* | :heavy_minus_sign: | The number of child items. | 6 |
|
| `ChildCount` | **int* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||||
| `AddedAt` | *int64* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `UpdatedAt` | *int64* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
| `UpdatedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `AudienceRatingImage` | *string* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||||
| `ParentIndex` | **int64* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
| `ParentIndex` | **int64* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||||
| `ParentThumb` | **string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
| `ParentThumb` | **string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||||
@@ -56,8 +58,8 @@
|
|||||||
| `UltraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
| `UltraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
||||||
| `Genre` | [][operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md) | :heavy_minus_sign: | An array of genre tags. | |
|
| `Genre` | [][operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md) | :heavy_minus_sign: | An array of genre tags. | |
|
||||||
| `Country` | [][operations.GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md) | :heavy_minus_sign: | An array of country tags. | |
|
| `Country` | [][operations.GetMediaMetaDataCountry](../../models/operations/getmediametadatacountry.md) | :heavy_minus_sign: | An array of country tags. | |
|
||||||
| `Guids` | [][operations.Guids](../../models/operations/guids.md) | :heavy_check_mark: | An array of GUID objects. | |
|
| `Guids` | [][operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md) | :heavy_minus_sign: | An array of GUID objects. | |
|
||||||
| `Rating` | [][operations.Rating](../../models/operations/rating.md) | :heavy_check_mark: | An array of rating objects. | |
|
| `Ratings` | [][operations.Ratings](../../models/operations/ratings.md) | :heavy_minus_sign: | An array of rating objects. | |
|
||||||
| `Role` | [][operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md) | :heavy_minus_sign: | An array of Actor roles. | |
|
| `Role` | [][operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md) | :heavy_minus_sign: | An array of Actor roles. | |
|
||||||
| `Director` | [][operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md) | :heavy_minus_sign: | An array of Director roles. | |
|
| `Director` | [][operations.GetMediaMetaDataDirector](../../models/operations/getmediametadatadirector.md) | :heavy_minus_sign: | An array of Director roles. | |
|
||||||
| `Writer` | [][operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md) | :heavy_minus_sign: | An array of Writer roles. | |
|
| `Writer` | [][operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md) | :heavy_minus_sign: | An array of Writer roles. | |
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
# GetMediaMetaDataOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### OptimizedForStreaming1
|
||||||
|
|
||||||
|
```go
|
||||||
|
getMediaMetaDataOptimizedForStreaming := operations.CreateGetMediaMetaDataOptimizedForStreamingOptimizedForStreaming1(operations.OptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getMediaMetaDataOptimizedForStreaming := operations.CreateGetMediaMetaDataOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetMediaMetaDataOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `GetMediaMetaDataOptimizedForStreaming1Zero` | 0 |
|
||||||
|
| `GetMediaMetaDataOptimizedForStreaming1One` | 1 |
|
||||||
@@ -4,15 +4,20 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `Duration` | *int64* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
| `Size` | *int64* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
| `Size` | *int64* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
| `Container` | *string* | :heavy_check_mark: | Container format of the part. | mkv |
|
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||||
| `VideoProfile` | *string* | :heavy_check_mark: | Video profile for the part. | main 10 |
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
| `Stream` | [][operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md) | :heavy_check_mark: | An array of streams for this part. | |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataLibraryOptimizedForStreaming](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `HasThumbnail` | [*operations.GetMediaMetaDataHasThumbnail](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `Stream` | [][operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md) | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
@@ -6,47 +6,48 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `StreamType` | *int64* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
| `StreamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `Index` | *int64* | :heavy_check_mark: | Index of the stream. | 0 |
|
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||||
| `Bitrate` | *int64* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||||
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||||
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||||
| `DOVIBLCompatID` | **int64* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `HeaderCompression` | **bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
|
| `DOVIBLCompatID` | **int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `DOVIBLPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
| `DOVIELPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
| `DOVIELPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
| `DOVILevel` | **int64* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
| `DOVILevel` | **int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
| `DOVIPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
| `DOVIPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
| `DOVIProfile` | **int64* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
| `DOVIProfile` | **int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
| `DOVIRPUPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
| `DOVIRPUPresent` | **bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
| `DOVIVersion` | **string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
| `DOVIVersion` | **string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
| `BitDepth` | **int64* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
| `BitDepth` | **int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
| `ChromaLocation` | **string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `CodedHeight` | **int64* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `CodedHeight` | **int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `CodedWidth` | **int64* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `CodedWidth` | **int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `ColorPrimaries` | **string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `ColorRange` | **string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `ColorSpace` | **string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
| `ColorTrc` | **string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
| `ColorTrc` | **string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
| `FrameRate` | **float32* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
| `FrameRate` | **float32* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
| `Height` | **int64* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
| `Height` | **int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
| `Level` | **int64* | :heavy_minus_sign: | Video level. | 150 |
|
| `Level` | **int* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
| `Original` | **bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
| `Original` | **bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `Profile` | **string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `Width` | **int64* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
| `Channels` | **int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
| `SamplingRate` | **int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
| `HearingImpaired` | **bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
| `Dub` | **bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
| `Dub` | **bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
|||||||
@@ -10,3 +10,4 @@
|
|||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Advanced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
@@ -12,3 +12,5 @@ The type of media content
|
|||||||
| `GetRecentlyAddedHubsTypeTvShow` | show |
|
| `GetRecentlyAddedHubsTypeTvShow` | show |
|
||||||
| `GetRecentlyAddedHubsTypeSeason` | season |
|
| `GetRecentlyAddedHubsTypeSeason` | season |
|
||||||
| `GetRecentlyAddedHubsTypeEpisode` | episode |
|
| `GetRecentlyAddedHubsTypeEpisode` | episode |
|
||||||
|
| `GetRecentlyAddedHubsTypeArtist` | artist |
|
||||||
|
| `GetRecentlyAddedHubsTypeAlbum` | album |
|
||||||
@@ -10,3 +10,4 @@
|
|||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Advanced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Subtype` | **string* | :heavy_minus_sign: | N/A | clip |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `Filter` | [][operations.GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
| `Filter` | [][operations.GetRecentlyAddedLibraryFilter](../../models/operations/getrecentlyaddedlibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A | 50 |
|
| `Size` | *int64* | :heavy_check_mark: | N/A | 50 |
|
||||||
| `Offset` | **int* | :heavy_minus_sign: | N/A | |
|
| `Offset` | **int* | :heavy_minus_sign: | N/A | |
|
||||||
| `TotalSize` | **int* | :heavy_minus_sign: | N/A | |
|
| `TotalSize` | **int* | :heavy_minus_sign: | N/A | |
|
||||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||||
|
|||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `Subtype` | **string* | :heavy_minus_sign: | N/A | clip |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `Filter` | [][operations.GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md) | :heavy_minus_sign: | N/A | |
|
| `Filter` | [][operations.GetRecentlyAddedFilter](../../models/operations/getrecentlyaddedfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetSearchAllLibrariesQueryParamIncludeCollections
|
||||||
|
|
||||||
|
Whether to include collections in the search results.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
|
| `GetSearchAllLibrariesQueryParamIncludeCollectionsDisable` | 0 |
|
||||||
|
| `GetSearchAllLibrariesQueryParamIncludeCollectionsEnable` | 1 |
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetSearchAllLibrariesQueryParamIncludeExternalMedia
|
||||||
|
|
||||||
|
Whether to include external media in the search results.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||||
|
| `GetSearchAllLibrariesQueryParamIncludeExternalMediaDisable` | 0 |
|
||||||
|
| `GetSearchAllLibrariesQueryParamIncludeExternalMediaEnable` | 1 |
|
||||||
@@ -4,10 +4,10 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Query` | *string* | :heavy_check_mark: | The search query term. | |
|
| `Query` | *string* | :heavy_check_mark: | The search query term. | |
|
||||||
| `ClientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
| `ClientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||||
| `Limit` | **int64* | :heavy_minus_sign: | Limit the number of results returned. | |
|
| `Limit` | **int64* | :heavy_minus_sign: | Limit the number of results returned. | |
|
||||||
| `SearchTypes` | [][operations.SearchTypes](../../models/operations/searchtypes.md) | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
|
| `SearchTypes` | [][operations.SearchTypes](../../models/operations/searchtypes.md) | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
|
||||||
| `IncludeCollections` | [*operations.QueryParamIncludeCollections](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
|
| `IncludeCollections` | [*operations.GetSearchAllLibrariesQueryParamIncludeCollections](../../models/operations/getsearchalllibrariesqueryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
|
||||||
| `IncludeExternalMedia` | [*operations.QueryParamIncludeExternalMedia](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
|
| `IncludeExternalMedia` | [*operations.GetSearchAllLibrariesQueryParamIncludeExternalMedia](../../models/operations/getsearchalllibrariesqueryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
|
||||||
@@ -12,3 +12,5 @@ The type of media content
|
|||||||
| `GetSearchAllLibrariesTypeTvShow` | show |
|
| `GetSearchAllLibrariesTypeTvShow` | show |
|
||||||
| `GetSearchAllLibrariesTypeSeason` | season |
|
| `GetSearchAllLibrariesTypeSeason` | season |
|
||||||
| `GetSearchAllLibrariesTypeEpisode` | episode |
|
| `GetSearchAllLibrariesTypeEpisode` | episode |
|
||||||
|
| `GetSearchAllLibrariesTypeArtist` | artist |
|
||||||
|
| `GetSearchAllLibrariesTypeAlbum` | album |
|
||||||
@@ -4,5 +4,5 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
| `ID` | **string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||||
9
docs/models/operations/includeadvanced.md
Normal file
9
docs/models/operations/includeadvanced.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# IncludeAdvanced
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------ | ------------------------ |
|
||||||
|
| `IncludeAdvancedDisable` | 0 |
|
||||||
|
| `IncludeAdvancedEnable` | 1 |
|
||||||
9
docs/models/operations/one.md
Normal file
9
docs/models/operations/one.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# One
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `OneZero` | 0 |
|
||||||
|
| `OneOne` | 1 |
|
||||||
9
docs/models/operations/optimizedforstreaming1.md
Normal file
9
docs/models/operations/optimizedforstreaming1.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# OptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------------------------- | ---------------------------- |
|
||||||
|
| `OptimizedForStreaming1Zero` | 0 |
|
||||||
|
| `OptimizedForStreaming1One` | 1 |
|
||||||
@@ -1,7 +1,5 @@
|
|||||||
# QueryParamIncludeCollections
|
# QueryParamIncludeCollections
|
||||||
|
|
||||||
Whether to include collections in the search results.
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
# QueryParamIncludeExternalMedia
|
# QueryParamIncludeExternalMedia
|
||||||
|
|
||||||
Whether to include external media in the search results.
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
12
docs/models/operations/queryparamincludeguids.md
Normal file
12
docs/models/operations/queryparamincludeguids.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# QueryParamIncludeGuids
|
||||||
|
|
||||||
|
Adds the Guid object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------- | ------------------------------- |
|
||||||
|
| `QueryParamIncludeGuidsDisable` | 0 |
|
||||||
|
| `QueryParamIncludeGuidsEnable` | 1 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Rating
|
# Ratings
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -7,7 +7,6 @@ A key representing a specific tag within the section.
|
|||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------------------- | ------------------- |
|
| ------------------- | ------------------- |
|
||||||
| `TagAll` | all |
|
|
||||||
| `TagUnwatched` | unwatched |
|
| `TagUnwatched` | unwatched |
|
||||||
| `TagNewest` | newest |
|
| `TagNewest` | newest |
|
||||||
| `TagRecentlyAdded` | recentlyAdded |
|
| `TagRecentlyAdded` | recentlyAdded |
|
||||||
@@ -15,12 +14,9 @@ A key representing a specific tag within the section.
|
|||||||
| `TagOnDeck` | onDeck |
|
| `TagOnDeck` | onDeck |
|
||||||
| `TagCollection` | collection |
|
| `TagCollection` | collection |
|
||||||
| `TagEdition` | edition |
|
| `TagEdition` | edition |
|
||||||
| `TagGenre` | genre |
|
|
||||||
| `TagYear` | year |
|
| `TagYear` | year |
|
||||||
| `TagDecade` | decade |
|
| `TagDecade` | decade |
|
||||||
| `TagDirector` | director |
|
| `TagDirector` | director |
|
||||||
| `TagActor` | actor |
|
|
||||||
| `TagCountry` | country |
|
|
||||||
| `TagContentRating` | contentRating |
|
| `TagContentRating` | contentRating |
|
||||||
| `TagRating` | rating |
|
| `TagRating` | rating |
|
||||||
| `TagResolution` | resolution |
|
| `TagResolution` | resolution |
|
||||||
|
|||||||
11
docs/models/sdkerrors/getallmedialibrarybadrequest.md
Normal file
11
docs/models/sdkerrors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
|
| `Errors` | [][sdkerrors.GetAllMediaLibraryErrors](../../models/sdkerrors/getallmedialibraryerrors.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
10
docs/models/sdkerrors/getallmedialibraryerrors.md
Normal file
10
docs/models/sdkerrors/getallmedialibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `Code` | **int* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `Message` | **string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `Status` | **int* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/sdkerrors/getallmedialibrarylibraryerrors.md
Normal file
10
docs/models/sdkerrors/getallmedialibrarylibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `Code` | **int* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `Message` | **string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `Status` | **int* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/sdkerrors/getallmedialibraryunauthorized.md
Normal file
11
docs/models/sdkerrors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `Errors` | [][sdkerrors.GetAllMediaLibraryLibraryErrors](../../models/sdkerrors/getallmedialibrarylibraryerrors.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -14,6 +14,7 @@ API Calls interacting with Plex Media Server Libraries
|
|||||||
* [GetLibraryDetails](#getlibrarydetails) - Get Library Details
|
* [GetLibraryDetails](#getlibrarydetails) - Get Library Details
|
||||||
* [DeleteLibrary](#deletelibrary) - Delete Library Section
|
* [DeleteLibrary](#deletelibrary) - Delete Library Section
|
||||||
* [GetLibraryItems](#getlibraryitems) - Get Library Items
|
* [GetLibraryItems](#getlibraryitems) - Get Library Items
|
||||||
|
* [GetAllMediaLibrary](#getallmedialibrary) - Get all media of library
|
||||||
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [GetSearchLibrary](#getsearchlibrary) - Search Library
|
* [GetSearchLibrary](#getsearchlibrary) - Search Library
|
||||||
* [GetGenresLibrary](#getgenreslibrary) - Get Genres of library media
|
* [GetGenresLibrary](#getgenreslibrary) - Get Genres of library media
|
||||||
@@ -429,6 +430,63 @@ func main() {
|
|||||||
| sdkerrors.GetLibraryItemsUnauthorized | 401 | application/json |
|
| sdkerrors.GetLibraryItemsUnauthorized | 401 | application/json |
|
||||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
## GetAllMediaLibrary
|
||||||
|
|
||||||
|
Retrieves a list of all general media data for this library.
|
||||||
|
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import(
|
||||||
|
"context"
|
||||||
|
"github.com/LukeHagar/plexgo"
|
||||||
|
"github.com/LukeHagar/plexgo/models/operations"
|
||||||
|
"log"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
s := plexgo.New(
|
||||||
|
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||||
|
)
|
||||||
|
|
||||||
|
res, err := s.Library.GetAllMediaLibrary(ctx, operations.GetAllMediaLibraryRequest{
|
||||||
|
SectionKey: 9518,
|
||||||
|
Type: operations.GetAllMediaLibraryQueryParamTypeTvShow,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
if res.Object != nil {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
|
||||||
|
| `request` | [operations.GetAllMediaLibraryRequest](../../models/operations/getallmedialibraryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||||
|
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. |
|
||||||
|
|
||||||
|
### Response
|
||||||
|
|
||||||
|
**[*operations.GetAllMediaLibraryResponse](../../models/operations/getallmedialibraryresponse.md), error**
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| sdkerrors.GetAllMediaLibraryBadRequest | 400 | application/json |
|
||||||
|
| sdkerrors.GetAllMediaLibraryUnauthorized | 401 | application/json |
|
||||||
|
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
## GetRefreshLibraryMetadata
|
## GetRefreshLibraryMetadata
|
||||||
|
|
||||||
This endpoint Refreshes all the Metadata of the library.
|
This endpoint Refreshes all the Metadata of the library.
|
||||||
|
|||||||
250
library.go
250
library.go
@@ -1543,6 +1543,256 @@ func (s *Library) GetLibraryItems(ctx context.Context, request operations.GetLib
|
|||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetAllMediaLibrary - Get all media of library
|
||||||
|
// Retrieves a list of all general media data for this library.
|
||||||
|
func (s *Library) GetAllMediaLibrary(ctx context.Context, request operations.GetAllMediaLibraryRequest, opts ...operations.Option) (*operations.GetAllMediaLibraryResponse, error) {
|
||||||
|
hookCtx := hooks.HookContext{
|
||||||
|
Context: ctx,
|
||||||
|
OperationID: "get-all-media-library",
|
||||||
|
OAuth2Scopes: []string{},
|
||||||
|
SecuritySource: s.sdkConfiguration.Security,
|
||||||
|
}
|
||||||
|
|
||||||
|
o := operations.Options{}
|
||||||
|
supportedOptions := []string{
|
||||||
|
operations.SupportedOptionRetries,
|
||||||
|
operations.SupportedOptionTimeout,
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, opt := range opts {
|
||||||
|
if err := opt(&o, supportedOptions...); err != nil {
|
||||||
|
return nil, fmt.Errorf("error applying option: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var baseURL string
|
||||||
|
if o.ServerURL == nil {
|
||||||
|
baseURL = utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails())
|
||||||
|
} else {
|
||||||
|
baseURL = *o.ServerURL
|
||||||
|
}
|
||||||
|
opURL, err := utils.GenerateURL(ctx, baseURL, "/library/sections/{sectionKey}/all", request, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error generating URL: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
timeout := o.Timeout
|
||||||
|
if timeout == nil {
|
||||||
|
timeout = s.sdkConfiguration.Timeout
|
||||||
|
}
|
||||||
|
|
||||||
|
if timeout != nil {
|
||||||
|
var cancel context.CancelFunc
|
||||||
|
ctx, cancel = context.WithTimeout(ctx, *timeout)
|
||||||
|
defer cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "GET", opURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("error creating request: %w", err)
|
||||||
|
}
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent)
|
||||||
|
|
||||||
|
if err := utils.PopulateQueryParams(ctx, req, request, nil); err != nil {
|
||||||
|
return nil, fmt.Errorf("error populating query params: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range o.SetHeaders {
|
||||||
|
req.Header.Set(k, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
globalRetryConfig := s.sdkConfiguration.RetryConfig
|
||||||
|
retryConfig := o.Retries
|
||||||
|
if retryConfig == nil {
|
||||||
|
if globalRetryConfig != nil {
|
||||||
|
retryConfig = globalRetryConfig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var httpRes *http.Response
|
||||||
|
if retryConfig != nil {
|
||||||
|
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||||
|
Config: retryConfig,
|
||||||
|
StatusCodes: []string{
|
||||||
|
"429",
|
||||||
|
"500",
|
||||||
|
"502",
|
||||||
|
"503",
|
||||||
|
"504",
|
||||||
|
},
|
||||||
|
}, func() (*http.Response, error) {
|
||||||
|
if req.Body != nil {
|
||||||
|
copyBody, err := req.GetBody()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
req.Body = copyBody
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err = s.sdkConfiguration.Hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req)
|
||||||
|
if err != nil {
|
||||||
|
if retry.IsPermanentError(err) || retry.IsTemporaryError(err) {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, retry.Permanent(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
httpRes, err := s.sdkConfiguration.Client.Do(req)
|
||||||
|
if err != nil || httpRes == nil {
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("error sending request: %w", err)
|
||||||
|
} else {
|
||||||
|
err = fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = s.sdkConfiguration.Hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err)
|
||||||
|
}
|
||||||
|
return httpRes, err
|
||||||
|
})
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
} else {
|
||||||
|
httpRes, err = s.sdkConfiguration.Hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
req, err = s.sdkConfiguration.Hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
httpRes, err = s.sdkConfiguration.Client.Do(req)
|
||||||
|
if err != nil || httpRes == nil {
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("error sending request: %w", err)
|
||||||
|
} else {
|
||||||
|
err = fmt.Errorf("error sending request: no response")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = s.sdkConfiguration.Hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err)
|
||||||
|
return nil, err
|
||||||
|
} else if utils.MatchStatusCodes([]string{"400", "401", "404", "4XX", "5XX"}, httpRes.StatusCode) {
|
||||||
|
_httpRes, err := s.sdkConfiguration.Hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, httpRes, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
} else if _httpRes != nil {
|
||||||
|
httpRes = _httpRes
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
httpRes, err = s.sdkConfiguration.Hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
res := &operations.GetAllMediaLibraryResponse{
|
||||||
|
StatusCode: httpRes.StatusCode,
|
||||||
|
ContentType: httpRes.Header.Get("Content-Type"),
|
||||||
|
RawResponse: httpRes,
|
||||||
|
}
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case httpRes.StatusCode == 200:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var out operations.GetAllMediaLibraryResponseBody
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
res.Object = &out
|
||||||
|
default:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
case httpRes.StatusCode == 400:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var out sdkerrors.GetAllMediaLibraryBadRequest
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
case httpRes.StatusCode == 401:
|
||||||
|
switch {
|
||||||
|
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var out sdkerrors.GetAllMediaLibraryUnauthorized
|
||||||
|
if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
out.RawResponse = httpRes
|
||||||
|
return nil, &out
|
||||||
|
default:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
case httpRes.StatusCode == 404:
|
||||||
|
fallthrough
|
||||||
|
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
default:
|
||||||
|
rawBody, err := utils.ConsumeRawBody(httpRes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
|
||||||
|
}
|
||||||
|
|
||||||
|
return res, nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
// GetRefreshLibraryMetadata - Refresh Metadata Of The Library
|
// GetRefreshLibraryMetadata - Refresh Metadata Of The Library
|
||||||
// This endpoint Refreshes all the Metadata of the library.
|
// This endpoint Refreshes all the Metadata of the library.
|
||||||
func (s *Library) GetRefreshLibraryMetadata(ctx context.Context, sectionKey int, force *operations.Force, opts ...operations.Option) (*operations.GetRefreshLibraryMetadataResponse, error) {
|
func (s *Library) GetRefreshLibraryMetadata(ctx context.Context, sectionKey int, force *operations.Force, opts ...operations.Option) (*operations.GetRefreshLibraryMetadataResponse, error) {
|
||||||
|
|||||||
@@ -124,7 +124,8 @@ func (o *GetActorsLibraryDirectory) GetTitle() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GetActorsLibraryMediaContainer struct {
|
type GetActorsLibraryMediaContainer struct {
|
||||||
Size float64 `json:"size"`
|
// Number of media items returned in this response.
|
||||||
|
Size int `json:"size"`
|
||||||
// Indicates whether syncing is allowed.
|
// Indicates whether syncing is allowed.
|
||||||
AllowSync bool `json:"allowSync"`
|
AllowSync bool `json:"allowSync"`
|
||||||
// URL for the background artwork of the media container.
|
// URL for the background artwork of the media container.
|
||||||
@@ -151,9 +152,9 @@ type GetActorsLibraryMediaContainer struct {
|
|||||||
Directory []GetActorsLibraryDirectory `json:"Directory,omitempty"`
|
Directory []GetActorsLibraryDirectory `json:"Directory,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetActorsLibraryMediaContainer) GetSize() float64 {
|
func (o *GetActorsLibraryMediaContainer) GetSize() int {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0.0
|
return 0
|
||||||
}
|
}
|
||||||
return o.Size
|
return o.Size
|
||||||
}
|
}
|
||||||
|
|||||||
2626
models/operations/getallmedialibrary.go
Normal file
2626
models/operations/getallmedialibrary.go
Normal file
File diff suppressed because it is too large
Load Diff
@@ -112,51 +112,40 @@ func (o *GetCountriesLibraryDirectory) GetTitle() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GetCountriesLibraryMediaContainer struct {
|
type GetCountriesLibraryMediaContainer struct {
|
||||||
Size float64 `json:"size"`
|
// Number of media items returned in this response.
|
||||||
Offset *int `json:"offset,omitempty"`
|
Size int `json:"size"`
|
||||||
TotalSize *int `json:"totalSize,omitempty"`
|
// Indicates whether syncing is allowed.
|
||||||
Identifier string `json:"identifier"`
|
|
||||||
AllowSync bool `json:"allowSync"`
|
AllowSync bool `json:"allowSync"`
|
||||||
|
// URL for the background artwork of the media container.
|
||||||
Art string `json:"art"`
|
Art string `json:"art"`
|
||||||
|
// The content type or mode.
|
||||||
Content string `json:"content"`
|
Content string `json:"content"`
|
||||||
|
// An plugin identifier for the media container.
|
||||||
|
Identifier string `json:"identifier"`
|
||||||
|
// The prefix used for media tag resource paths.
|
||||||
MediaTagPrefix string `json:"mediaTagPrefix"`
|
MediaTagPrefix string `json:"mediaTagPrefix"`
|
||||||
|
// The version number for media tags.
|
||||||
MediaTagVersion int64 `json:"mediaTagVersion"`
|
MediaTagVersion int64 `json:"mediaTagVersion"`
|
||||||
|
// Specifies whether caching is disabled.
|
||||||
Nocache bool `json:"nocache"`
|
Nocache bool `json:"nocache"`
|
||||||
|
// URL for the thumbnail image of the media container.
|
||||||
Thumb string `json:"thumb"`
|
Thumb string `json:"thumb"`
|
||||||
|
// The primary title of the media container.
|
||||||
Title1 string `json:"title1"`
|
Title1 string `json:"title1"`
|
||||||
|
// The secondary title of the media container.
|
||||||
Title2 string `json:"title2"`
|
Title2 string `json:"title2"`
|
||||||
|
// Identifier for the view group layout.
|
||||||
ViewGroup string `json:"viewGroup"`
|
ViewGroup string `json:"viewGroup"`
|
||||||
Directory []GetCountriesLibraryDirectory `json:"Directory,omitempty"`
|
Directory []GetCountriesLibraryDirectory `json:"Directory,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetSize() float64 {
|
func (o *GetCountriesLibraryMediaContainer) GetSize() int {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0.0
|
return 0
|
||||||
}
|
}
|
||||||
return o.Size
|
return o.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetOffset() *int {
|
|
||||||
if o == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return o.Offset
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetTotalSize() *int {
|
|
||||||
if o == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return o.TotalSize
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetIdentifier() string {
|
|
||||||
if o == nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return o.Identifier
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetAllowSync() bool {
|
func (o *GetCountriesLibraryMediaContainer) GetAllowSync() bool {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return false
|
return false
|
||||||
@@ -178,6 +167,13 @@ func (o *GetCountriesLibraryMediaContainer) GetContent() string {
|
|||||||
return o.Content
|
return o.Content
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetCountriesLibraryMediaContainer) GetIdentifier() string {
|
||||||
|
if o == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return o.Identifier
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetCountriesLibraryMediaContainer) GetMediaTagPrefix() string {
|
func (o *GetCountriesLibraryMediaContainer) GetMediaTagPrefix() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
|
|||||||
@@ -120,51 +120,40 @@ func (o *GetGenresLibraryDirectory) GetType() string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GetGenresLibraryMediaContainer struct {
|
type GetGenresLibraryMediaContainer struct {
|
||||||
Size float64 `json:"size"`
|
// Number of media items returned in this response.
|
||||||
Offset *int `json:"offset,omitempty"`
|
Size int `json:"size"`
|
||||||
TotalSize *int `json:"totalSize,omitempty"`
|
// Indicates whether syncing is allowed.
|
||||||
Identifier string `json:"identifier"`
|
|
||||||
AllowSync bool `json:"allowSync"`
|
AllowSync bool `json:"allowSync"`
|
||||||
|
// URL for the background artwork of the media container.
|
||||||
Art string `json:"art"`
|
Art string `json:"art"`
|
||||||
|
// The content type or mode.
|
||||||
Content string `json:"content"`
|
Content string `json:"content"`
|
||||||
|
// An plugin identifier for the media container.
|
||||||
|
Identifier string `json:"identifier"`
|
||||||
|
// The prefix used for media tag resource paths.
|
||||||
MediaTagPrefix string `json:"mediaTagPrefix"`
|
MediaTagPrefix string `json:"mediaTagPrefix"`
|
||||||
|
// The version number for media tags.
|
||||||
MediaTagVersion int64 `json:"mediaTagVersion"`
|
MediaTagVersion int64 `json:"mediaTagVersion"`
|
||||||
|
// Specifies whether caching is disabled.
|
||||||
Nocache bool `json:"nocache"`
|
Nocache bool `json:"nocache"`
|
||||||
|
// URL for the thumbnail image of the media container.
|
||||||
Thumb string `json:"thumb"`
|
Thumb string `json:"thumb"`
|
||||||
|
// The primary title of the media container.
|
||||||
Title1 string `json:"title1"`
|
Title1 string `json:"title1"`
|
||||||
|
// The secondary title of the media container.
|
||||||
Title2 string `json:"title2"`
|
Title2 string `json:"title2"`
|
||||||
|
// Identifier for the view group layout.
|
||||||
ViewGroup string `json:"viewGroup"`
|
ViewGroup string `json:"viewGroup"`
|
||||||
Directory []GetGenresLibraryDirectory `json:"Directory,omitempty"`
|
Directory []GetGenresLibraryDirectory `json:"Directory,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetSize() float64 {
|
func (o *GetGenresLibraryMediaContainer) GetSize() int {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0.0
|
return 0
|
||||||
}
|
}
|
||||||
return o.Size
|
return o.Size
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetOffset() *int {
|
|
||||||
if o == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return o.Offset
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetTotalSize() *int {
|
|
||||||
if o == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return o.TotalSize
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetIdentifier() string {
|
|
||||||
if o == nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return o.Identifier
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetAllowSync() bool {
|
func (o *GetGenresLibraryMediaContainer) GetAllowSync() bool {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return false
|
return false
|
||||||
@@ -186,6 +175,13 @@ func (o *GetGenresLibraryMediaContainer) GetContent() string {
|
|||||||
return o.Content
|
return o.Content
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetGenresLibraryMediaContainer) GetIdentifier() string {
|
||||||
|
if o == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return o.Identifier
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetGenresLibraryMediaContainer) GetMediaTagPrefix() string {
|
func (o *GetGenresLibraryMediaContainer) GetMediaTagPrefix() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ import (
|
|||||||
type Tag string
|
type Tag string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
TagAll Tag = "all"
|
|
||||||
TagUnwatched Tag = "unwatched"
|
TagUnwatched Tag = "unwatched"
|
||||||
TagNewest Tag = "newest"
|
TagNewest Tag = "newest"
|
||||||
TagRecentlyAdded Tag = "recentlyAdded"
|
TagRecentlyAdded Tag = "recentlyAdded"
|
||||||
@@ -22,12 +21,9 @@ const (
|
|||||||
TagOnDeck Tag = "onDeck"
|
TagOnDeck Tag = "onDeck"
|
||||||
TagCollection Tag = "collection"
|
TagCollection Tag = "collection"
|
||||||
TagEdition Tag = "edition"
|
TagEdition Tag = "edition"
|
||||||
TagGenre Tag = "genre"
|
|
||||||
TagYear Tag = "year"
|
TagYear Tag = "year"
|
||||||
TagDecade Tag = "decade"
|
TagDecade Tag = "decade"
|
||||||
TagDirector Tag = "director"
|
TagDirector Tag = "director"
|
||||||
TagActor Tag = "actor"
|
|
||||||
TagCountry Tag = "country"
|
|
||||||
TagContentRating Tag = "contentRating"
|
TagContentRating Tag = "contentRating"
|
||||||
TagRating Tag = "rating"
|
TagRating Tag = "rating"
|
||||||
TagResolution Tag = "resolution"
|
TagResolution Tag = "resolution"
|
||||||
@@ -45,8 +41,6 @@ func (e *Tag) UnmarshalJSON(data []byte) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
switch v {
|
switch v {
|
||||||
case "all":
|
|
||||||
fallthrough
|
|
||||||
case "unwatched":
|
case "unwatched":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "newest":
|
case "newest":
|
||||||
@@ -61,18 +55,12 @@ func (e *Tag) UnmarshalJSON(data []byte) error {
|
|||||||
fallthrough
|
fallthrough
|
||||||
case "edition":
|
case "edition":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "genre":
|
|
||||||
fallthrough
|
|
||||||
case "year":
|
case "year":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "decade":
|
case "decade":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "director":
|
case "director":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "actor":
|
|
||||||
fallthrough
|
|
||||||
case "country":
|
|
||||||
fallthrough
|
|
||||||
case "contentRating":
|
case "contentRating":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "rating":
|
case "rating":
|
||||||
@@ -291,6 +279,7 @@ type GetLibraryItemsFilter struct {
|
|||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Advanced *bool `json:"advanced,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibraryItemsFilter) GetFilter() string {
|
func (o *GetLibraryItemsFilter) GetFilter() string {
|
||||||
@@ -328,6 +317,13 @@ func (o *GetLibraryItemsFilter) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetLibraryItemsFilter) GetAdvanced() *bool {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Advanced
|
||||||
|
}
|
||||||
|
|
||||||
// GetLibraryItemsActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
// GetLibraryItemsActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
||||||
type GetLibraryItemsActiveDirection string
|
type GetLibraryItemsActiveDirection string
|
||||||
|
|
||||||
@@ -502,6 +498,7 @@ func (o *GetLibraryItemsField) GetSubType() *string {
|
|||||||
type GetLibraryItemsType struct {
|
type GetLibraryItemsType struct {
|
||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Subtype *string `json:"subtype,omitempty"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Active bool `json:"active"`
|
Active bool `json:"active"`
|
||||||
Filter []GetLibraryItemsFilter `json:"Filter,omitempty"`
|
Filter []GetLibraryItemsFilter `json:"Filter,omitempty"`
|
||||||
@@ -523,6 +520,13 @@ func (o *GetLibraryItemsType) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetLibraryItemsType) GetSubtype() *string {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Subtype
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetLibraryItemsType) GetTitle() string {
|
func (o *GetLibraryItemsType) GetTitle() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
@@ -604,6 +608,8 @@ const (
|
|||||||
GetLibraryItemsLibraryTypeTvShow GetLibraryItemsLibraryType = "show"
|
GetLibraryItemsLibraryTypeTvShow GetLibraryItemsLibraryType = "show"
|
||||||
GetLibraryItemsLibraryTypeSeason GetLibraryItemsLibraryType = "season"
|
GetLibraryItemsLibraryTypeSeason GetLibraryItemsLibraryType = "season"
|
||||||
GetLibraryItemsLibraryTypeEpisode GetLibraryItemsLibraryType = "episode"
|
GetLibraryItemsLibraryTypeEpisode GetLibraryItemsLibraryType = "episode"
|
||||||
|
GetLibraryItemsLibraryTypeArtist GetLibraryItemsLibraryType = "artist"
|
||||||
|
GetLibraryItemsLibraryTypeAlbum GetLibraryItemsLibraryType = "album"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (e GetLibraryItemsLibraryType) ToPointer() *GetLibraryItemsLibraryType {
|
func (e GetLibraryItemsLibraryType) ToPointer() *GetLibraryItemsLibraryType {
|
||||||
@@ -622,6 +628,10 @@ func (e *GetLibraryItemsLibraryType) UnmarshalJSON(data []byte) error {
|
|||||||
case "season":
|
case "season":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "episode":
|
case "episode":
|
||||||
|
fallthrough
|
||||||
|
case "artist":
|
||||||
|
fallthrough
|
||||||
|
case "album":
|
||||||
*e = GetLibraryItemsLibraryType(v)
|
*e = GetLibraryItemsLibraryType(v)
|
||||||
return nil
|
return nil
|
||||||
default:
|
default:
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -180,6 +180,7 @@ type GetRecentlyAddedFilter struct {
|
|||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Advanced *bool `json:"advanced,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedFilter) GetFilter() string {
|
func (o *GetRecentlyAddedFilter) GetFilter() string {
|
||||||
@@ -217,6 +218,13 @@ func (o *GetRecentlyAddedFilter) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetRecentlyAddedFilter) GetAdvanced() *bool {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Advanced
|
||||||
|
}
|
||||||
|
|
||||||
// GetRecentlyAddedActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
// GetRecentlyAddedActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
||||||
type GetRecentlyAddedActiveDirection string
|
type GetRecentlyAddedActiveDirection string
|
||||||
|
|
||||||
@@ -391,6 +399,7 @@ func (o *GetRecentlyAddedField) GetSubType() *string {
|
|||||||
type GetRecentlyAddedType struct {
|
type GetRecentlyAddedType struct {
|
||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Subtype *string `json:"subtype,omitempty"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Active bool `json:"active"`
|
Active bool `json:"active"`
|
||||||
Filter []GetRecentlyAddedFilter `json:"Filter,omitempty"`
|
Filter []GetRecentlyAddedFilter `json:"Filter,omitempty"`
|
||||||
@@ -412,6 +421,13 @@ func (o *GetRecentlyAddedType) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetRecentlyAddedType) GetSubtype() *string {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Subtype
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedType) GetTitle() string {
|
func (o *GetRecentlyAddedType) GetTitle() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
@@ -513,6 +529,8 @@ const (
|
|||||||
GetRecentlyAddedHubsTypeTvShow GetRecentlyAddedHubsType = "show"
|
GetRecentlyAddedHubsTypeTvShow GetRecentlyAddedHubsType = "show"
|
||||||
GetRecentlyAddedHubsTypeSeason GetRecentlyAddedHubsType = "season"
|
GetRecentlyAddedHubsTypeSeason GetRecentlyAddedHubsType = "season"
|
||||||
GetRecentlyAddedHubsTypeEpisode GetRecentlyAddedHubsType = "episode"
|
GetRecentlyAddedHubsTypeEpisode GetRecentlyAddedHubsType = "episode"
|
||||||
|
GetRecentlyAddedHubsTypeArtist GetRecentlyAddedHubsType = "artist"
|
||||||
|
GetRecentlyAddedHubsTypeAlbum GetRecentlyAddedHubsType = "album"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (e GetRecentlyAddedHubsType) ToPointer() *GetRecentlyAddedHubsType {
|
func (e GetRecentlyAddedHubsType) ToPointer() *GetRecentlyAddedHubsType {
|
||||||
@@ -531,6 +549,10 @@ func (e *GetRecentlyAddedHubsType) UnmarshalJSON(data []byte) error {
|
|||||||
case "season":
|
case "season":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "episode":
|
case "episode":
|
||||||
|
fallthrough
|
||||||
|
case "artist":
|
||||||
|
fallthrough
|
||||||
|
case "album":
|
||||||
*e = GetRecentlyAddedHubsType(v)
|
*e = GetRecentlyAddedHubsType(v)
|
||||||
return nil
|
return nil
|
||||||
default:
|
default:
|
||||||
@@ -2244,7 +2266,7 @@ func (o *GetRecentlyAddedMetadata) GetParentTheme() *string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GetRecentlyAddedMediaContainer struct {
|
type GetRecentlyAddedMediaContainer struct {
|
||||||
Size float64 `json:"size"`
|
Size int64 `json:"size"`
|
||||||
Offset *int `json:"offset,omitempty"`
|
Offset *int `json:"offset,omitempty"`
|
||||||
TotalSize *int `json:"totalSize,omitempty"`
|
TotalSize *int `json:"totalSize,omitempty"`
|
||||||
Identifier *string `json:"identifier,omitempty"`
|
Identifier *string `json:"identifier,omitempty"`
|
||||||
@@ -2255,9 +2277,9 @@ type GetRecentlyAddedMediaContainer struct {
|
|||||||
Metadata []GetRecentlyAddedMetadata `json:"Metadata,omitempty"`
|
Metadata []GetRecentlyAddedMetadata `json:"Metadata,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedMediaContainer) GetSize() float64 {
|
func (o *GetRecentlyAddedMediaContainer) GetSize() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0.0
|
return 0
|
||||||
}
|
}
|
||||||
return o.Size
|
return o.Size
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -178,6 +178,7 @@ type GetRecentlyAddedLibraryFilter struct {
|
|||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Advanced *bool `json:"advanced,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedLibraryFilter) GetFilter() string {
|
func (o *GetRecentlyAddedLibraryFilter) GetFilter() string {
|
||||||
@@ -215,6 +216,13 @@ func (o *GetRecentlyAddedLibraryFilter) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetRecentlyAddedLibraryFilter) GetAdvanced() *bool {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Advanced
|
||||||
|
}
|
||||||
|
|
||||||
// ActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
// ActiveDirection - The direction of the sort. Can be either `asc` or `desc`.
|
||||||
type ActiveDirection string
|
type ActiveDirection string
|
||||||
|
|
||||||
@@ -389,6 +397,7 @@ func (o *Field) GetSubType() *string {
|
|||||||
type GetRecentlyAddedLibraryType struct {
|
type GetRecentlyAddedLibraryType struct {
|
||||||
Key string `json:"key"`
|
Key string `json:"key"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
|
Subtype *string `json:"subtype,omitempty"`
|
||||||
Title string `json:"title"`
|
Title string `json:"title"`
|
||||||
Active bool `json:"active"`
|
Active bool `json:"active"`
|
||||||
Filter []GetRecentlyAddedLibraryFilter `json:"Filter,omitempty"`
|
Filter []GetRecentlyAddedLibraryFilter `json:"Filter,omitempty"`
|
||||||
@@ -410,6 +419,13 @@ func (o *GetRecentlyAddedLibraryType) GetType() string {
|
|||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (o *GetRecentlyAddedLibraryType) GetSubtype() *string {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Subtype
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedLibraryType) GetTitle() string {
|
func (o *GetRecentlyAddedLibraryType) GetTitle() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
|
|||||||
@@ -45,18 +45,18 @@ func (e *SearchTypes) UnmarshalJSON(data []byte) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryParamIncludeCollections - Whether to include collections in the search results.
|
// GetSearchAllLibrariesQueryParamIncludeCollections - Whether to include collections in the search results.
|
||||||
type QueryParamIncludeCollections int
|
type GetSearchAllLibrariesQueryParamIncludeCollections int
|
||||||
|
|
||||||
const (
|
const (
|
||||||
QueryParamIncludeCollectionsDisable QueryParamIncludeCollections = 0
|
GetSearchAllLibrariesQueryParamIncludeCollectionsDisable GetSearchAllLibrariesQueryParamIncludeCollections = 0
|
||||||
QueryParamIncludeCollectionsEnable QueryParamIncludeCollections = 1
|
GetSearchAllLibrariesQueryParamIncludeCollectionsEnable GetSearchAllLibrariesQueryParamIncludeCollections = 1
|
||||||
)
|
)
|
||||||
|
|
||||||
func (e QueryParamIncludeCollections) ToPointer() *QueryParamIncludeCollections {
|
func (e GetSearchAllLibrariesQueryParamIncludeCollections) ToPointer() *GetSearchAllLibrariesQueryParamIncludeCollections {
|
||||||
return &e
|
return &e
|
||||||
}
|
}
|
||||||
func (e *QueryParamIncludeCollections) UnmarshalJSON(data []byte) error {
|
func (e *GetSearchAllLibrariesQueryParamIncludeCollections) UnmarshalJSON(data []byte) error {
|
||||||
var v int
|
var v int
|
||||||
if err := json.Unmarshal(data, &v); err != nil {
|
if err := json.Unmarshal(data, &v); err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -65,25 +65,25 @@ func (e *QueryParamIncludeCollections) UnmarshalJSON(data []byte) error {
|
|||||||
case 0:
|
case 0:
|
||||||
fallthrough
|
fallthrough
|
||||||
case 1:
|
case 1:
|
||||||
*e = QueryParamIncludeCollections(v)
|
*e = GetSearchAllLibrariesQueryParamIncludeCollections(v)
|
||||||
return nil
|
return nil
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("invalid value for QueryParamIncludeCollections: %v", v)
|
return fmt.Errorf("invalid value for GetSearchAllLibrariesQueryParamIncludeCollections: %v", v)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// QueryParamIncludeExternalMedia - Whether to include external media in the search results.
|
// GetSearchAllLibrariesQueryParamIncludeExternalMedia - Whether to include external media in the search results.
|
||||||
type QueryParamIncludeExternalMedia int
|
type GetSearchAllLibrariesQueryParamIncludeExternalMedia int
|
||||||
|
|
||||||
const (
|
const (
|
||||||
QueryParamIncludeExternalMediaDisable QueryParamIncludeExternalMedia = 0
|
GetSearchAllLibrariesQueryParamIncludeExternalMediaDisable GetSearchAllLibrariesQueryParamIncludeExternalMedia = 0
|
||||||
QueryParamIncludeExternalMediaEnable QueryParamIncludeExternalMedia = 1
|
GetSearchAllLibrariesQueryParamIncludeExternalMediaEnable GetSearchAllLibrariesQueryParamIncludeExternalMedia = 1
|
||||||
)
|
)
|
||||||
|
|
||||||
func (e QueryParamIncludeExternalMedia) ToPointer() *QueryParamIncludeExternalMedia {
|
func (e GetSearchAllLibrariesQueryParamIncludeExternalMedia) ToPointer() *GetSearchAllLibrariesQueryParamIncludeExternalMedia {
|
||||||
return &e
|
return &e
|
||||||
}
|
}
|
||||||
func (e *QueryParamIncludeExternalMedia) UnmarshalJSON(data []byte) error {
|
func (e *GetSearchAllLibrariesQueryParamIncludeExternalMedia) UnmarshalJSON(data []byte) error {
|
||||||
var v int
|
var v int
|
||||||
if err := json.Unmarshal(data, &v); err != nil {
|
if err := json.Unmarshal(data, &v); err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -92,10 +92,10 @@ func (e *QueryParamIncludeExternalMedia) UnmarshalJSON(data []byte) error {
|
|||||||
case 0:
|
case 0:
|
||||||
fallthrough
|
fallthrough
|
||||||
case 1:
|
case 1:
|
||||||
*e = QueryParamIncludeExternalMedia(v)
|
*e = GetSearchAllLibrariesQueryParamIncludeExternalMedia(v)
|
||||||
return nil
|
return nil
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("invalid value for QueryParamIncludeExternalMedia: %v", v)
|
return fmt.Errorf("invalid value for GetSearchAllLibrariesQueryParamIncludeExternalMedia: %v", v)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -110,9 +110,9 @@ type GetSearchAllLibrariesRequest struct {
|
|||||||
//
|
//
|
||||||
SearchTypes []SearchTypes `queryParam:"style=form,explode=false,name=searchTypes"`
|
SearchTypes []SearchTypes `queryParam:"style=form,explode=false,name=searchTypes"`
|
||||||
// Whether to include collections in the search results.
|
// Whether to include collections in the search results.
|
||||||
IncludeCollections *QueryParamIncludeCollections `default:"0" queryParam:"style=form,explode=true,name=includeCollections"`
|
IncludeCollections *GetSearchAllLibrariesQueryParamIncludeCollections `default:"0" queryParam:"style=form,explode=true,name=includeCollections"`
|
||||||
// Whether to include external media in the search results.
|
// Whether to include external media in the search results.
|
||||||
IncludeExternalMedia *QueryParamIncludeExternalMedia `default:"0" queryParam:"style=form,explode=true,name=includeExternalMedia"`
|
IncludeExternalMedia *GetSearchAllLibrariesQueryParamIncludeExternalMedia `default:"0" queryParam:"style=form,explode=true,name=includeExternalMedia"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (g GetSearchAllLibrariesRequest) MarshalJSON() ([]byte, error) {
|
func (g GetSearchAllLibrariesRequest) MarshalJSON() ([]byte, error) {
|
||||||
@@ -154,14 +154,14 @@ func (o *GetSearchAllLibrariesRequest) GetSearchTypes() []SearchTypes {
|
|||||||
return o.SearchTypes
|
return o.SearchTypes
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetSearchAllLibrariesRequest) GetIncludeCollections() *QueryParamIncludeCollections {
|
func (o *GetSearchAllLibrariesRequest) GetIncludeCollections() *GetSearchAllLibrariesQueryParamIncludeCollections {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.IncludeCollections
|
return o.IncludeCollections
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetSearchAllLibrariesRequest) GetIncludeExternalMedia() *QueryParamIncludeExternalMedia {
|
func (o *GetSearchAllLibrariesRequest) GetIncludeExternalMedia() *GetSearchAllLibrariesQueryParamIncludeExternalMedia {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -176,6 +176,8 @@ const (
|
|||||||
GetSearchAllLibrariesTypeTvShow GetSearchAllLibrariesType = "show"
|
GetSearchAllLibrariesTypeTvShow GetSearchAllLibrariesType = "show"
|
||||||
GetSearchAllLibrariesTypeSeason GetSearchAllLibrariesType = "season"
|
GetSearchAllLibrariesTypeSeason GetSearchAllLibrariesType = "season"
|
||||||
GetSearchAllLibrariesTypeEpisode GetSearchAllLibrariesType = "episode"
|
GetSearchAllLibrariesTypeEpisode GetSearchAllLibrariesType = "episode"
|
||||||
|
GetSearchAllLibrariesTypeArtist GetSearchAllLibrariesType = "artist"
|
||||||
|
GetSearchAllLibrariesTypeAlbum GetSearchAllLibrariesType = "album"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (e GetSearchAllLibrariesType) ToPointer() *GetSearchAllLibrariesType {
|
func (e GetSearchAllLibrariesType) ToPointer() *GetSearchAllLibrariesType {
|
||||||
@@ -194,6 +196,10 @@ func (e *GetSearchAllLibrariesType) UnmarshalJSON(data []byte) error {
|
|||||||
case "season":
|
case "season":
|
||||||
fallthrough
|
fallthrough
|
||||||
case "episode":
|
case "episode":
|
||||||
|
fallthrough
|
||||||
|
case "artist":
|
||||||
|
fallthrough
|
||||||
|
case "album":
|
||||||
*e = GetSearchAllLibrariesType(v)
|
*e = GetSearchAllLibrariesType(v)
|
||||||
return nil
|
return nil
|
||||||
default:
|
default:
|
||||||
|
|||||||
90
models/sdkerrors/getallmedialibrary.go
Normal file
90
models/sdkerrors/getallmedialibrary.go
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||||
|
|
||||||
|
package sdkerrors
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
type GetAllMediaLibraryLibraryErrors struct {
|
||||||
|
Code *int `json:"code,omitempty"`
|
||||||
|
Message *string `json:"message,omitempty"`
|
||||||
|
Status *int `json:"status,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryLibraryErrors) GetCode() *int {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Code
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryLibraryErrors) GetMessage() *string {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Message
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryLibraryErrors) GetStatus() *int {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Status
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAllMediaLibraryUnauthorized - Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
type GetAllMediaLibraryUnauthorized struct {
|
||||||
|
Errors []GetAllMediaLibraryLibraryErrors `json:"errors,omitempty"`
|
||||||
|
// Raw HTTP response; suitable for custom response parsing
|
||||||
|
RawResponse *http.Response `json:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = &GetAllMediaLibraryUnauthorized{}
|
||||||
|
|
||||||
|
func (e *GetAllMediaLibraryUnauthorized) Error() string {
|
||||||
|
data, _ := json.Marshal(e)
|
||||||
|
return string(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
type GetAllMediaLibraryErrors struct {
|
||||||
|
Code *int `json:"code,omitempty"`
|
||||||
|
Message *string `json:"message,omitempty"`
|
||||||
|
Status *int `json:"status,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryErrors) GetCode() *int {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Code
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryErrors) GetMessage() *string {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Message
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o *GetAllMediaLibraryErrors) GetStatus() *int {
|
||||||
|
if o == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return o.Status
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAllMediaLibraryBadRequest - Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
type GetAllMediaLibraryBadRequest struct {
|
||||||
|
Errors []GetAllMediaLibraryErrors `json:"errors,omitempty"`
|
||||||
|
// Raw HTTP response; suitable for custom response parsing
|
||||||
|
RawResponse *http.Response `json:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = &GetAllMediaLibraryBadRequest{}
|
||||||
|
|
||||||
|
func (e *GetAllMediaLibraryBadRequest) Error() string {
|
||||||
|
data, _ := json.Marshal(e)
|
||||||
|
return string(data)
|
||||||
|
}
|
||||||
@@ -299,9 +299,9 @@ func New(opts ...SDKOption) *PlexAPI {
|
|||||||
sdkConfiguration: sdkConfiguration{
|
sdkConfiguration: sdkConfiguration{
|
||||||
Language: "go",
|
Language: "go",
|
||||||
OpenAPIDocVersion: "0.0.3",
|
OpenAPIDocVersion: "0.0.3",
|
||||||
SDKVersion: "0.18.1",
|
SDKVersion: "0.19.0",
|
||||||
GenVersion: "2.506.0",
|
GenVersion: "2.506.0",
|
||||||
UserAgent: "speakeasy-sdk/go 0.18.1 2.506.0 0.0.3 github.com/LukeHagar/plexgo",
|
UserAgent: "speakeasy-sdk/go 0.19.0 2.506.0 0.0.3 github.com/LukeHagar/plexgo",
|
||||||
ServerDefaults: []map[string]string{
|
ServerDefaults: []map[string]string{
|
||||||
{
|
{
|
||||||
"protocol": "https",
|
"protocol": "https",
|
||||||
|
|||||||
Reference in New Issue
Block a user