LukeParke/plexgo
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexgo.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.555.3

Browse Source
This commit is contained in:
speakeasybot
2025-06-05 00:12:09 +00:00
parent d9f461ec33
commit 8c4caee48d
149 changed files with 3663 additions and 2976 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sdks/authentication/README.md
View File

@@ -92,7 +92,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Authentication.GetSourceConnectionInformation(ctx, "provider://provider-identifier")
res, err := s.Authentication.GetSourceConnectionInformation(ctx, "server://client-identifier")
if err != nil {
log.Fatal(err)
}

4
docs/sdks/butler/README.md
View File

@@ -201,7 +201,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Butler.StartTask(ctx, operations.TaskNameCleanOldBundles)
res, err := s.Butler.StartTask(ctx, operations.TaskNameRefreshPeriodicMetadata)
if err != nil {
log.Fatal(err)
}
@@ -255,7 +255,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Butler.StopTask(ctx, operations.PathParamTaskNameBackupDatabase)
res, err := s.Butler.StopTask(ctx, operations.PathParamTaskNameCleanOldCacheFiles)
if err != nil {
log.Fatal(err)
}

5
docs/sdks/hubs/README.md
View File

@@ -90,9 +90,10 @@ func main() {
)
res, err := s.Hubs.GetRecentlyAdded(ctx, operations.GetRecentlyAddedRequest{
ContentDirectoryID: 470161,
ContentDirectoryID: 39486,
SectionID: plexgo.Int64(2),
Type: operations.TypeTvShow,
IncludeMeta: operations.IncludeMetaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
@@ -144,7 +145,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Hubs.GetLibraryHubs(ctx, 6728.76, nil, nil)
res, err := s.Hubs.GetLibraryHubs(ctx, 492.74, nil, nil)
if err != nil {
log.Fatal(err)
}

58
docs/sdks/library/README.md
View File

@@ -14,7 +14,7 @@ API Calls interacting with Plex Media Server Libraries
* [GetLibraryDetails](#getlibrarydetails) - Get Library Details
* [DeleteLibrary](#deletelibrary) - Delete Library Section
* [GetLibraryItems](#getlibraryitems) - Get Library Items
* [GetAllMediaLibrary](#getallmedialibrary) - Get all media of library
* [GetLibrarySectionsAll](#getlibrarysectionsall) - Get Library section media by tag ALL
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [GetSearchLibrary](#getsearchlibrary) - Search Library
* [GetGenresLibrary](#getgenreslibrary) - Get Genres of library media
@@ -124,6 +124,7 @@ func main() {
},
SectionID: plexgo.Int64(2),
Type: operations.QueryParamTypeTvShow,
IncludeMeta: operations.QueryParamIncludeMetaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
@@ -262,6 +263,7 @@ package main
import(
"context"
"github.com/LukeHagar/plexgo"
"github.com/LukeHagar/plexgo/models/operations"
"log"
)
@@ -272,7 +274,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Library.GetLibraryDetails(ctx, 9518, nil)
res, err := s.Library.GetLibraryDetails(ctx, 9518, operations.IncludeDetailsZero.ToPointer())
if err != nil {
log.Fatal(err)
}
@@ -400,9 +402,11 @@ func main() {
)
res, err := s.Library.GetLibraryItems(ctx, operations.GetLibraryItemsRequest{
Tag: operations.TagEdition,
Tag: operations.TagNewest,
IncludeGuids: operations.IncludeGuidsEnable.ToPointer(),
Type: operations.GetLibraryItemsQueryParamTypeTvShow,
SectionKey: 9518,
IncludeMeta: operations.GetLibraryItemsQueryParamIncludeMetaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
@@ -433,7 +437,7 @@ func main() {
| sdkerrors.GetLibraryItemsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetAllMediaLibrary
## GetLibrarySectionsAll
Retrieves a list of all general media data for this library.
@@ -457,9 +461,14 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Library.GetAllMediaLibrary(ctx, operations.GetAllMediaLibraryRequest{
res, err := s.Library.GetLibrarySectionsAll(ctx, operations.GetLibrarySectionsAllRequest{
SectionKey: 9518,
Type: operations.GetAllMediaLibraryQueryParamTypeTvShow,
Type: operations.GetLibrarySectionsAllQueryParamTypeTvShow,
IncludeMeta: operations.GetLibrarySectionsAllQueryParamIncludeMetaEnable.ToPointer(),
IncludeGuids: operations.QueryParamIncludeGuidsEnable.ToPointer(),
IncludeAdvanced: operations.IncludeAdvancedEnable.ToPointer(),
IncludeCollections: operations.QueryParamIncludeCollectionsEnable.ToPointer(),
IncludeExternalMedia: operations.QueryParamIncludeExternalMediaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
@@ -472,23 +481,23 @@ func main() {
### 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. |
| 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.GetLibrarySectionsAllRequest](../../models/operations/getlibrarysectionsallrequest.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**
**[*operations.GetLibrarySectionsAllResponse](../../models/operations/getlibrarysectionsallresponse.md), error**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.GetAllMediaLibraryBadRequest | 400 | application/json |
| sdkerrors.GetAllMediaLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| sdkerrors.GetLibrarySectionsAllBadRequest | 400 | application/json |
| sdkerrors.GetLibrarySectionsAllUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRefreshLibraryMetadata
@@ -514,7 +523,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Library.GetRefreshLibraryMetadata(ctx, 9518, operations.ForceOne.ToPointer())
res, err := s.Library.GetRefreshLibraryMetadata(ctx, 9518, operations.ForceZero.ToPointer())
if err != nil {
log.Fatal(err)
}
@@ -812,6 +821,8 @@ func main() {
SearchTypes: []operations.SearchTypes{
operations.SearchTypesPeople,
},
IncludeCollections: operations.GetSearchAllLibrariesQueryParamIncludeCollectionsEnable.ToPointer(),
IncludeExternalMedia: operations.GetSearchAllLibrariesQueryParamIncludeExternalMediaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
@@ -844,7 +855,8 @@ func main() {
## GetMediaMetaData
This endpoint will return all the (meta)data of a library item specified with by the ratingKey.
This endpoint will return all the (meta)data of one or more library items specified by the ratingKey.
Multiple rating keys can be provided as a comma-separated list (e.g., "21119,21617").
### Example Usage
@@ -867,7 +879,7 @@ func main() {
)
res, err := s.Library.GetMediaMetaData(ctx, operations.GetMediaMetaDataRequest{
RatingKey: 9518,
RatingKey: "21119,21617",
IncludeConcerts: plexgo.Bool(true),
IncludeExtras: plexgo.Bool(true),
IncludeOnDeck: plexgo.Bool(true),
@@ -1138,7 +1150,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Library.GetMetadataChildren(ctx, 1539.14, plexgo.String("Stream"))
res, err := s.Library.GetMetadataChildren(ctx, 2403.67, plexgo.String("Stream"))
if err != nil {
log.Fatal(err)
}
@@ -1193,7 +1205,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Library.GetTopWatchedContent(ctx, operations.GetTopWatchedContentQueryParamTypeTvShow, plexgo.Int64(1))
res, err := s.Library.GetTopWatchedContent(ctx, operations.GetTopWatchedContentQueryParamTypeTvShow, operations.GetTopWatchedContentQueryParamIncludeGuidsEnable.ToPointer())
if err != nil {
log.Fatal(err)
}
@@ -1209,7 +1221,7 @@ func main() {
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
| `type_` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.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 |
| `includeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `includeGuids` | [*operations.GetTopWatchedContentQueryParamIncludeGuids](../../models/operations/gettopwatchedcontentqueryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
### Response

18
docs/sdks/playlists/README.md
View File

@@ -49,9 +49,9 @@ func main() {
res, err := s.Playlists.CreatePlaylist(ctx, operations.CreatePlaylistRequest{
Title: "<value>",
Type: operations.CreatePlaylistQueryParamTypePhoto,
Type: operations.CreatePlaylistQueryParamTypeAudio,
Smart: operations.SmartOne,
URI: "https://hoarse-testing.info/",
URI: "https://short-term-disconnection.name/",
})
if err != nil {
log.Fatal(err)
@@ -159,7 +159,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.GetPlaylist(ctx, 4109.48)
res, err := s.Playlists.GetPlaylist(ctx, 8419.53)
if err != nil {
log.Fatal(err)
}
@@ -212,7 +212,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.DeletePlaylist(ctx, 216.22)
res, err := s.Playlists.DeletePlaylist(ctx, 3432.93)
if err != nil {
log.Fatal(err)
}
@@ -265,7 +265,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.UpdatePlaylist(ctx, 3915, nil, nil)
res, err := s.Playlists.UpdatePlaylist(ctx, 1579.66, nil, nil)
if err != nil {
log.Fatal(err)
}
@@ -324,7 +324,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.GetPlaylistContents(ctx, 5004.46, operations.GetPlaylistContentsQueryParamTypeTvShow)
res, err := s.Playlists.GetPlaylistContents(ctx, 5535.42, operations.GetPlaylistContentsQueryParamTypeTvShow)
if err != nil {
log.Fatal(err)
}
@@ -378,7 +378,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.ClearPlaylistContents(ctx, 1893.18)
res, err := s.Playlists.ClearPlaylistContents(ctx, 4137.37)
if err != nil {
log.Fatal(err)
}
@@ -432,7 +432,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.AddPlaylistContents(ctx, 8502.01, "server://12345/com.plexapp.plugins.library/library/metadata/1", plexgo.Float64(123))
res, err := s.Playlists.AddPlaylistContents(ctx, 7013.44, "server://12345/com.plexapp.plugins.library/library/metadata/1", plexgo.Float64(123))
if err != nil {
log.Fatal(err)
}
@@ -488,7 +488,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Playlists.UploadPlaylist(ctx, "/home/barkley/playlist.m3u", operations.QueryParamForceZero, 1)
res, err := s.Playlists.UploadPlaylist(ctx, "/home/barkley/playlist.m3u", operations.QueryParamForceOne, 1)
if err != nil {
log.Fatal(err)
}

5
docs/sdks/plex/README.md
View File

@@ -230,6 +230,7 @@ package main
import(
"context"
"github.com/LukeHagar/plexgo"
"github.com/LukeHagar/plexgo/models/operations"
"log"
)
@@ -240,7 +241,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Plex.GetServerResources(ctx, "3381b62b-9ab7-4e37-827b-203e9809eb58", nil, nil, nil)
res, err := s.Plex.GetServerResources(ctx, "3381b62b-9ab7-4e37-827b-203e9809eb58", operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer())
if err != nil {
log.Fatal(err)
}
@@ -351,7 +352,7 @@ func main() {
s := plexgo.New()
res, err := s.Plex.GetTokenByPinID(ctx, operations.GetTokenByPinIDRequest{
PinID: 408895,
PinID: 232248,
ClientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
ClientName: plexgo.String("Plex for Roku"),
DeviceNickname: plexgo.String("Roku 3"),

4
docs/sdks/search/README.md
View File

@@ -46,7 +46,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Search.PerformSearch(ctx, "dylan", nil, nil)
res, err := s.Search.PerformSearch(ctx, "arnold", nil, plexgo.Float64(5))
if err != nil {
log.Fatal(err)
}
@@ -104,7 +104,7 @@ func main() {
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Search.PerformVoiceSearch(ctx, "dead+poop", nil, nil)
res, err := s.Search.PerformVoiceSearch(ctx, "dead+poop", nil, plexgo.Float64(5))
if err != nil {
log.Fatal(err)
}

5
docs/sdks/server/README.md
View File

@@ -348,10 +348,9 @@ func main() {
res, err := s.Server.GetResizedPhoto(ctx, operations.GetResizedPhotoRequest{
Width: 110,
Height: 165,
Opacity: 100,
Blur: 0,
MinSize: operations.MinSizeOne,
Upscale: operations.UpscaleOne,
MinSize: operations.MinSizeZero,
Upscale: operations.UpscaleZero,
URL: "/library/metadata/49564/thumb/1654258204",
})
if err != nil {

2
docs/sdks/watchlist/README.md
View File

@@ -34,7 +34,7 @@ func main() {
)
res, err := s.Watchlist.GetWatchList(ctx, operations.GetWatchListRequest{
Filter: operations.FilterAvailable,
Filter: operations.FilterReleased,
XPlexToken: "CV5xoxjTpFKUzBTShsaf",
})
if err != nil {