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.405.6

Browse Source
This commit is contained in:
speakeasybot
2024-10-01 00:11:35 +00:00
parent c65c9e0cae
commit 636840a553
51 changed files with 809 additions and 866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/sdks/activities/README.md
View File

@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetServerActivitiesBadRequest | 400 | application/json |
| sdkerrors.GetServerActivitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## CancelServerActivities
@@ -123,8 +122,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.CancelServerActivitiesBadRequest | 400 | application/json |
| sdkerrors.CancelServerActivitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetTransientTokenBadRequest | 400 | application/json |
| sdkerrors.GetTransientTokenUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSourceConnectionInformation
@@ -125,12 +124,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| sdkerrors.GetSourceConnectionInformationBadRequest | 400 | application/json |
| sdkerrors.GetSourceConnectionInformationUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTokenDetails
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetTokenDetailsBadRequest | 400 | application/json |
| sdkerrors.GetTokenDetailsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## PostUsersSignInData
@@ -244,8 +241,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.PostUsersSignInDataBadRequest | 400 | application/json |
| sdkerrors.PostUsersSignInDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -63,12 +63,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetButlerTasksBadRequest | 400 | application/json |
| sdkerrors.GetButlerTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StartAllTasks
@@ -124,12 +123,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.StartAllTasksBadRequest | 400 | application/json |
| sdkerrors.StartAllTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StopAllTasks
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.StopAllTasksBadRequest | 400 | application/json |
| sdkerrors.StopAllTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StartTask
@@ -244,12 +241,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| sdkerrors.StartTaskBadRequest | 400 | application/json |
| sdkerrors.StartTaskUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StopTask
@@ -303,8 +299,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| sdkerrors.StopTaskBadRequest | 400 | application/json |
| sdkerrors.StopTaskUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -63,12 +63,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetGlobalHubsBadRequest | 400 | application/json |
| sdkerrors.GetGlobalHubsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRecentlyAdded
@@ -129,10 +128,9 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------ | ------------------ | ------------------ |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryHubs
@@ -187,8 +185,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetLibraryHubsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryHubsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -72,12 +72,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetFileHashBadRequest | 400 | application/json |
| sdkerrors.GetFileHashUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRecentlyAddedLibrary
@@ -152,12 +151,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| sdkerrors.GetRecentlyAddedLibraryBadRequest | 400 | application/json |
| sdkerrors.GetRecentlyAddedLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetAllLibraries
@@ -214,12 +212,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetAllLibrariesBadRequest | 400 | application/json |
| sdkerrors.GetAllLibrariesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryDetails
@@ -311,12 +308,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetLibraryDetailsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryDetailsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## DeleteLibrary
@@ -368,12 +364,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.DeleteLibraryBadRequest | 400 | application/json |
| sdkerrors.DeleteLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryItems
@@ -454,12 +449,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetLibraryItemsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryItemsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRefreshLibraryMetadata
@@ -514,12 +508,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| sdkerrors.GetRefreshLibraryMetadataBadRequest | 400 | application/json |
| sdkerrors.GetRefreshLibraryMetadataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSearchLibrary
@@ -591,12 +584,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.GetSearchLibraryBadRequest | 400 | application/json |
| sdkerrors.GetSearchLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMetaDataByRatingKey
@@ -649,12 +641,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.GetMetaDataByRatingKeyBadRequest | 400 | application/json |
| sdkerrors.GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMetadataChildren
@@ -708,12 +699,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetMetadataChildrenBadRequest | 400 | application/json |
| sdkerrors.GetMetadataChildrenUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTopWatchedContent
@@ -768,12 +758,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| sdkerrors.GetTopWatchedContentBadRequest | 400 | application/json |
| sdkerrors.GetTopWatchedContentUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetOnDeck
@@ -825,8 +814,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| sdkerrors.GetOnDeckBadRequest | 400 | application/json |
| sdkerrors.GetOnDeckUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

14
docs/sdks/log/README.md
View File

@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| sdkerrors.LogLineBadRequest | 400 | application/json |
| sdkerrors.LogLineUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## LogMultiLine
@@ -146,12 +145,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.LogMultiLineBadRequest | 400 | application/json |
| sdkerrors.LogMultiLineUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## EnablePaperTrail
@@ -203,8 +201,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.EnablePaperTrailBadRequest | 400 | application/json |
| sdkerrors.EnablePaperTrailUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

24
docs/sdks/media/README.md
View File

@@ -64,12 +64,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| sdkerrors.MarkPlayedBadRequest | 400 | application/json |
| sdkerrors.MarkPlayedUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## MarkUnplayed
@@ -121,12 +120,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.MarkUnplayedBadRequest | 400 | application/json |
| sdkerrors.MarkUnplayedUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## UpdatePlayProgress
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.UpdatePlayProgressBadRequest | 400 | application/json |
| sdkerrors.UpdatePlayProgressUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetBannerImage
@@ -246,12 +243,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetBannerImageBadRequest | 400 | application/json |
| sdkerrors.GetBannerImageUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetThumbImage
@@ -311,8 +307,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetThumbImageBadRequest | 400 | application/json |
| sdkerrors.GetThumbImageUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -80,12 +80,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.CreatePlaylistBadRequest | 400 | application/json |
| sdkerrors.CreatePlaylistUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetPlaylists
@@ -138,12 +137,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.GetPlaylistsBadRequest | 400 | application/json |
| sdkerrors.GetPlaylistsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetPlaylist
@@ -197,12 +195,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetPlaylistBadRequest | 400 | application/json |
| sdkerrors.GetPlaylistUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## DeletePlaylist
@@ -255,12 +252,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.DeletePlaylistBadRequest | 400 | application/json |
| sdkerrors.DeletePlaylistUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## UpdatePlaylist
@@ -315,12 +311,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.UpdatePlaylistBadRequest | 400 | application/json |
| sdkerrors.UpdatePlaylistUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetPlaylistContents
@@ -378,12 +373,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetPlaylistContentsBadRequest | 400 | application/json |
| sdkerrors.GetPlaylistContentsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## ClearPlaylistContents
@@ -436,12 +430,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| sdkerrors.ClearPlaylistContentsBadRequest | 400 | application/json |
| sdkerrors.ClearPlaylistContentsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## AddPlaylistContents
@@ -497,12 +490,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.AddPlaylistContentsBadRequest | 400 | application/json |
| sdkerrors.AddPlaylistContentsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## UploadPlaylist
@@ -558,8 +550,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.UploadPlaylistBadRequest | 400 | application/json |
| sdkerrors.UploadPlaylistUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -65,12 +65,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetCompanionsDataBadRequest | 400 | application/json |
| sdkerrors.GetCompanionsDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetUserFriends
@@ -121,12 +120,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetUserFriendsBadRequest | 400 | application/json |
| sdkerrors.GetUserFriendsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetGeoData
@@ -176,12 +174,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| sdkerrors.GetGeoDataBadRequest | 400 | application/json |
| sdkerrors.GetGeoDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetHomeData
@@ -232,12 +229,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetHomeDataBadRequest | 400 | application/json |
| sdkerrors.GetHomeDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetServerResources
@@ -266,7 +262,7 @@ func main() {
)
ctx := context.Background()
res, err := s.Plex.GetServerResources(ctx, operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer())
res, err := s.Plex.GetServerResources(ctx, operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer(), plexgo.String("gcgzw5rz2xovp84b4vha3a40"))
if err != nil {
log.Fatal(err)
}
@@ -278,13 +274,14 @@ func main() {
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
| `includeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
| `includeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | **string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
### Response
@@ -292,12 +289,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.GetServerResourcesBadRequest | 400 | application/json |
| sdkerrors.GetServerResourcesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetPin
@@ -349,11 +345,10 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| sdkerrors.GetPinBadRequest | 400 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTokenByPinID
@@ -367,6 +362,7 @@ package main
import(
"github.com/LukeHagar/plexgo"
"context"
"github.com/LukeHagar/plexgo/models/operations"
"log"
)
@@ -380,7 +376,9 @@ func main() {
)
ctx := context.Background()
res, err := s.Plex.GetTokenByPinID(ctx, 408895)
res, err := s.Plex.GetTokenByPinID(ctx, operations.GetTokenByPinIDRequest{
PinID: 408895,
})
if err != nil {
log.Fatal(err)
}
@@ -392,11 +390,11 @@ 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. |
| `pinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `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.GetTokenByPinIDRequest](../../models/operations/gettokenbypinidrequest.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
@@ -404,8 +402,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetTokenByPinIDBadRequest | 400 | application/json |
| sdkerrors.GetTokenByPinIDResponseBody | 404 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

25
docs/sdks/plexapi/README.md
View File

@@ -2,4 +2,27 @@
## Overview
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
# Plex Media Server OpenAPI Specification
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## SDKs
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
| Language | Repository | Releases | Other |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -

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

@@ -76,12 +76,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.PerformSearchBadRequest | 400 | application/json |
| sdkerrors.PerformSearchUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## PerformVoiceSearch
@@ -139,12 +138,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.PerformVoiceSearchBadRequest | 400 | application/json |
| sdkerrors.PerformVoiceSearchUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSearchResults
@@ -196,8 +194,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.GetSearchResultsBadRequest | 400 | application/json |
| sdkerrors.GetSearchResultsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -67,12 +67,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json |
| sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetServerPreferences
@@ -123,12 +122,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| sdkerrors.GetServerPreferencesBadRequest | 400 | application/json |
| sdkerrors.GetServerPreferencesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetAvailableClients
@@ -179,12 +177,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetAvailableClientsBadRequest | 400 | application/json |
| sdkerrors.GetAvailableClientsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetDevices
@@ -235,12 +232,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| sdkerrors.GetDevicesBadRequest | 400 | application/json |
| sdkerrors.GetDevicesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetServerIdentity
@@ -290,11 +286,10 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetServerIdentityRequestTimeout | 408 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMyPlexAccount
@@ -345,12 +340,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.GetMyPlexAccountBadRequest | 400 | application/json |
| sdkerrors.GetMyPlexAccountUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetResizedPhoto
@@ -412,12 +406,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetResizedPhotoBadRequest | 400 | application/json |
| sdkerrors.GetResizedPhotoUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMediaProviders
@@ -469,12 +462,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetMediaProvidersBadRequest | 400 | application/json |
| sdkerrors.GetMediaProvidersUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetServerList
@@ -525,8 +517,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetServerListBadRequest | 400 | application/json |
| sdkerrors.GetServerListUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

19
docs/sdks/sessions/README.md
View File

@@ -62,12 +62,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetSessionsBadRequest | 400 | application/json |
| sdkerrors.GetSessionsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSessionHistory
@@ -123,12 +122,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetSessionHistoryBadRequest | 400 | application/json |
| sdkerrors.GetSessionHistoryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTranscodeSessions
@@ -179,12 +177,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| sdkerrors.GetTranscodeSessionsBadRequest | 400 | application/json |
| sdkerrors.GetTranscodeSessionsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StopTranscodeSession
@@ -236,8 +233,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| sdkerrors.StopTranscodeSessionBadRequest | 400 | application/json |
| sdkerrors.StopTranscodeSessionUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

14
docs/sdks/statistics/README.md
View File

@@ -62,12 +62,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetStatisticsBadRequest | 400 | application/json |
| sdkerrors.GetStatisticsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetResourcesStatistics
@@ -119,12 +118,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.GetResourcesStatisticsBadRequest | 400 | application/json |
| sdkerrors.GetResourcesStatisticsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetBandwidthStatistics
@@ -176,8 +174,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.GetBandwidthStatisticsBadRequest | 400 | application/json |
| sdkerrors.GetBandwidthStatisticsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

14
docs/sdks/updater/README.md
View File

@@ -62,12 +62,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetUpdateStatusBadRequest | 400 | application/json |
| sdkerrors.GetUpdateStatusUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## CheckForUpdates
@@ -120,12 +119,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.CheckForUpdatesBadRequest | 400 | application/json |
| sdkerrors.CheckForUpdatesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## ApplyUpdates
@@ -180,8 +178,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.ApplyUpdatesBadRequest | 400 | application/json |
| sdkerrors.ApplyUpdatesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

9
docs/sdks/video/README.md
View File

@@ -73,12 +73,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetTimelineBadRequest | 400 | application/json |
| sdkerrors.GetTimelineUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StartUniversalTranscode
@@ -148,8 +147,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| sdkerrors.StartUniversalTranscodeBadRequest | 400 | application/json |
| sdkerrors.StartUniversalTranscodeUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

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

@@ -66,8 +66,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.GetWatchListBadRequest | 400 | application/json |
| sdkerrors.GetWatchListUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |