From 636840a553c46147ac75353ebaddb901756b7dd7 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 1 Oct 2024 00:11:35 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 --- .speakeasy/gen.lock | 27 +- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- README.md | 49 ++- RELEASES.md | 12 +- codeSamples.yaml | 7 +- docs/models/operations/connections.md | 18 +- docs/models/operations/features.md | 38 +- docs/models/operations/getpinglobals.md | 14 +- docs/models/operations/getpinrequest.md | 16 +- .../operations/getserverresourcesglobals.md | 8 + .../operations/getserverresourcesrequest.md | 11 +- .../operations/gettokenbypinidglobals.md | 12 + .../operations/gettokenbypinidrequest.md | 11 +- .../operations/gettokendetailsfeatures.md | 38 +- .../gettokendetailsuserplexaccount.md | 2 +- docs/models/operations/mailingliststatus.md | 2 +- ...stuserssignindataauthenticationfeatures.md | 38 +- .../operations/postuserssignindatafeatures.md | 38 +- .../operations/postuserssignindataglobals.md | 14 +- .../postuserssignindatamailingliststatus.md | 2 +- .../operations/postuserssignindatarequest.md | 16 +- .../postuserssignindatauserplexaccount.md | 2 +- docs/sdks/activities/README.md | 9 +- docs/sdks/authentication/README.md | 19 +- docs/sdks/butler/README.md | 24 +- docs/sdks/hubs/README.md | 14 +- docs/sdks/library/README.md | 59 ++- docs/sdks/log/README.md | 14 +- docs/sdks/media/README.md | 24 +- docs/sdks/playlists/README.md | 44 +-- docs/sdks/plex/README.md | 66 ++-- docs/sdks/plexapi/README.md | 25 +- docs/sdks/search/README.md | 14 +- docs/sdks/server/README.md | 44 +-- docs/sdks/sessions/README.md | 19 +- docs/sdks/statistics/README.md | 14 +- docs/sdks/updater/README.md | 14 +- docs/sdks/video/README.md | 9 +- docs/sdks/watchlist/README.md | 4 +- internal/globals/globals.go | 5 +- models/operations/getcompanionsdata.go | 2 +- models/operations/getgeodata.go | 2 +- models/operations/getpin.go | 12 +- models/operations/getserverresources.go | 23 +- models/operations/gettokenbypinid.go | 87 ++++- models/operations/gettokendetails.go | 336 ++++------------- models/operations/getuserfriends.go | 2 +- models/operations/postuserssignindata.go | 346 ++++-------------- plex.go | 25 +- plexapi.go | 30 +- 51 files changed, 809 insertions(+), 866 deletions(-) create mode 100644 docs/models/operations/getserverresourcesglobals.md create mode 100644 docs/models/operations/gettokenbypinidglobals.md diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index b3c1247..dd50439 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: dfa99515-01c0-42eb-9be5-ee212fd03eb3 management: - docChecksum: 5e039359563b41bbe118fc6701ba22dc + docChecksum: f12b653820ae77ca3b2820bc9459d866 docVersion: 0.0.3 - speakeasyVersion: 1.402.14 - generationVersion: 2.422.22 - releaseVersion: 0.13.0 - configChecksum: 6aa0259125228f92fd7f2b813993a97e + speakeasyVersion: 1.405.6 + generationVersion: 2.428.1 + releaseVersion: 0.14.0 + configChecksum: b3f62e5341e89e4827891e48d581a6c3 repoURL: https://github.com/LukeHagar/plexgo.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/plexgo @@ -15,13 +15,13 @@ features: go: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.6 - core: 3.5.10 + core: 3.5.12 defaultEnabledRetries: 0.2.0 deprecations: 2.81.1 downloadStreams: 0.1.2 enums: 2.81.1 envVarSecurityUsage: 0.3.1 - errors: 2.81.9 + errors: 2.81.10 flattening: 2.81.1 globalSecurity: 2.82.10 globalSecurityCallbacks: 0.1.0 @@ -32,6 +32,7 @@ features: methodServerURLs: 2.82.1 nameOverrides: 2.81.2 nullables: 0.1.0 + openEnums: 0.1.0 responseFormat: 0.1.2 retries: 2.83.0 sdkHooks: 0.1.0 @@ -477,6 +478,7 @@ generatedFiles: - docs/models/operations/getserverpreferencesmediacontainer.md - docs/models/operations/getserverpreferencesresponse.md - docs/models/operations/getserverpreferencesresponsebody.md + - docs/models/operations/getserverresourcesglobals.md - docs/models/operations/getserverresourcesrequest.md - docs/models/operations/getserverresourcesresponse.md - docs/models/operations/getsessionhistorymediacontainer.md @@ -505,6 +507,7 @@ generatedFiles: - docs/models/operations/gettimelineresponse.md - docs/models/operations/gettokenbypinidauthpincontainer.md - docs/models/operations/gettokenbypinidgeodata.md + - docs/models/operations/gettokenbypinidglobals.md - docs/models/operations/gettokenbypinidrequest.md - docs/models/operations/gettokenbypinidresponse.md - docs/models/operations/gettokendetailsauthenticationresponsestatus.md @@ -1314,6 +1317,7 @@ examples: includeHttps: 1 includeRelay: 1 includeIPv6: 1 + X-Plex-Client-Identifier: "gcgzw5rz2xovp84b4vha3a40" responses: "200": application/json: [] @@ -1342,7 +1346,12 @@ examples: parameters: path: pinID: 408895 - query: {} + query: + X-Plex-Client-Identifier: "gcgzw5rz2xovp84b4vha3a40" + X-Plex-Product: "Plex Web" + X-Plex-Device: "Linux" + X-Plex-Version: "4.133.0" + X-Plex-Platform: "Chrome" responses: "404": application/json: {"errors": [{"code": 1020, "message": "Code not found or expired"}]} @@ -1982,7 +1991,7 @@ examples: speakeasy-default-get-token-details: responses: "200": - application/json: {"adsConsent": true, "adsConsentReminderAt": "2019-08-24T14:15:22Z", "adsConsentSetAt": "2019-08-24T14:15:22Z", "anonymous": false, "authToken": "CxoUzBTSV5hsxjTpFKaf", "backupCodesCreated": false, "confirmed": false, "country": "US", "email": "username@email.com", "emailOnlyAuth": false, "experimentalFeatures": false, "friendlyName": "friendlyUsername", "entitlements": ["[]"], "guest": false, "hasPassword": true, "home": false, "homeAdmin": false, "homeSize": 1, "id": 13692262, "joinedAt": 1556281940, "locale": null, "mailingListActive": false, "mailingListStatus": "unsubscribed", "maxHomeSize": 15, "pin": "string", "profile": {"autoSelectAudio": true, "defaultAudioLanguage": "ja", "defaultSubtitleLanguage": "en", "autoSelectSubtitle": 1, "defaultSubtitleAccessibility": 1, "defaultSubtitleForced": 1, "watchedIndicator": 1, "mediaReviewsVisibility": 1}, "protected": false, "rememberExpiresAt": 1556281940, "restricted": false, "roles": ["string"], "scrobbleTypes": "", "services": [{"identifier": "metadata-dev", "endpoint": "https://epg.provider.plex.tv", "token": "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv", "secret": "string", "status": "online"}], "subscription": {"features": ["Android - Dolby Vision"], "active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive", "paymentService": "string", "plan": "string"}, "subscriptionDescription": "string", "subscriptions": [{"features": ["Android - Dolby Vision"], "active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive", "paymentService": "string", "plan": "string"}], "thumb": "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101", "title": "UsernameTitle", "twoFactorEnabled": false, "username": "Username", "uuid": "dae343c1f45beb4f", "attributionPartner": null} + application/json: {"adsConsent": true, "adsConsentReminderAt": "2019-08-24T14:15:22Z", "adsConsentSetAt": "2019-08-24T14:15:22Z", "anonymous": false, "authToken": "CxoUzBTSV5hsxjTpFKaf", "backupCodesCreated": false, "confirmed": false, "country": "US", "email": "username@email.com", "emailOnlyAuth": false, "experimentalFeatures": false, "friendlyName": "friendlyUsername", "entitlements": ["[]"], "guest": false, "hasPassword": true, "home": false, "homeAdmin": false, "homeSize": 1, "id": 13692262, "joinedAt": 1556281940, "locale": null, "mailingListActive": false, "mailingListStatus": "active", "maxHomeSize": 15, "pin": "string", "profile": {"autoSelectAudio": true, "defaultAudioLanguage": "ja", "defaultSubtitleLanguage": "en", "autoSelectSubtitle": 1, "defaultSubtitleAccessibility": 1, "defaultSubtitleForced": 1, "watchedIndicator": 1, "mediaReviewsVisibility": 1}, "protected": false, "rememberExpiresAt": 1556281940, "restricted": false, "roles": ["string"], "scrobbleTypes": "", "services": [{"identifier": "metadata-dev", "endpoint": "https://epg.provider.plex.tv", "token": "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv", "secret": "string", "status": "online"}], "subscription": {"features": ["Android - Dolby Vision"], "active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive", "paymentService": "string", "plan": "string"}, "subscriptionDescription": "string", "subscriptions": [{"features": ["Android - Dolby Vision"], "active": true, "subscribedAt": "2021-04-12T18:21:12Z", "status": "Inactive", "paymentService": "string", "plan": "string"}], "thumb": "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101", "title": "UsernameTitle", "twoFactorEnabled": false, "username": "Username", "uuid": "dae343c1f45beb4f", "attributionPartner": null} "400": application/json: {"errors": []} "401": diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 08ba08c..66c9957 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true go: - version: 0.13.0 + version: 0.14.0 additionalDependencies: {} allowUnknownFieldsInWeakUnions: false clientServerStatusCodesAsErrors: true diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index c5973c5..eb6791e 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.402.14 +speakeasyVersion: 1.405.6 sources: my-source: sourceNamespace: my-source @@ -9,8 +9,8 @@ sources: - main plexapi: sourceNamespace: plexapi - sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e - sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 tags: - latest - main @@ -18,10 +18,10 @@ targets: plexgo: source: plexapi sourceNamespace: plexapi - sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e - sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 codeSamplesNamespace: code-samples-go-plexgo - codeSamplesRevisionDigest: sha256:77cf87f3a1619a7cf598f60cf04a2f82dd0809dd1d449c2a1f67a63729f5726a + codeSamplesRevisionDigest: sha256:02a3daa914a5c29e77e5cae2f0c1ca74840d6627a908b2a8d890e93d99bd3767 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index dc1d086..af9f313 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,31 @@ ## Summary 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) | - @@ -304,13 +329,17 @@ func main() { ## Error Handling -Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass. +Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. -| Error Object | Status Code | Content Type | +By Default, an API error will return `sdkerrors.SDKError`. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. + +For example, the `GetServerCapabilities` function may return the following errors: + +| Error Type | Status Code | Content Type | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | | sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json | | sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json | -| sdkerrors.SDKError | 4xx-5xx | */* | +| sdkerrors.SDKError | 4XX, 5XX | \*/\* | ### Example @@ -473,7 +502,7 @@ func main() { ) ctx := context.Background() - res, err := s.Plex.GetCompanionsData(ctx, operations.WithServerURL("https://plex.tv/api/v2/")) + res, err := s.Plex.GetCompanionsData(ctx, operations.WithServerURL("https://plex.tv/api/v2")) if err != nil { log.Fatal(err) } @@ -589,7 +618,7 @@ d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed. -For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. +For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. ### Available Globals @@ -598,10 +627,7 @@ The following global parameters are available. | Name | Type | Required | Description | | ---- | ---- |:--------:| ----------- | -| ClientID | string | | 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) - | +| ClientID | string | | 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) | | ClientName | string | | The ClientName parameter. | | ClientVersion | string | | The ClientVersion parameter. | | ClientPlatform | string | | The ClientPlatform parameter. | @@ -622,6 +648,7 @@ import ( func main() { s := plexgo.New( + plexgo.WithSecurity(""), plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"), plexgo.WithClientName("Plex Web"), plexgo.WithClientVersion("4.133.0"), @@ -630,11 +657,11 @@ func main() { ) ctx := context.Background() - res, err := s.Plex.GetPin(ctx, operations.GetPinRequest{}) + res, err := s.Plex.GetServerResources(ctx, operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer(), plexgo.String("gcgzw5rz2xovp84b4vha3a40")) if err != nil { log.Fatal(err) } - if res.AuthPinContainer != nil { + if res.PlexDevices != nil { // handle response } } diff --git a/RELEASES.md b/RELEASES.md index 53be32b..d7c94d8 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -922,4 +922,14 @@ Based on: ### Generated - [go v0.13.0] . ### Releases -- [Go v0.13.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.13.0 - . \ No newline at end of file +- [Go v0.13.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.13.0 - . + +## 2024-10-01 00:10:01 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [go v0.14.0] . +### Releases +- [Go v0.14.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.14.0 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index 1e1cafd..029e27f 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -1653,6 +1653,7 @@ actions: import( "github.com/LukeHagar/plexgo" "context" + "github.com/LukeHagar/plexgo/models/operations" "log" ) @@ -1666,7 +1667,9 @@ actions: ) 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) } @@ -2005,7 +2008,7 @@ actions: ) 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) } diff --git a/docs/models/operations/connections.md b/docs/models/operations/connections.md index 0726348..2798b78 100644 --- a/docs/models/operations/connections.md +++ b/docs/models/operations/connections.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | -| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection | -| `Port` | *int* | :heavy_check_mark: | The port used for the connection | -| `URI` | *string* | :heavy_check_mark: | The full URI of the connection | -| `Local` | *bool* | :heavy_check_mark: | If the connection is local address | -| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct | -| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `Protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http | +| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection | | +| `Port` | *int* | :heavy_check_mark: | The port used for the connection | | +| `URI` | *string* | :heavy_check_mark: | The full URI of the connection | | +| `Local` | *bool* | :heavy_check_mark: | If the connection is local address | | +| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct | | +| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 | | \ No newline at end of file diff --git a/docs/models/operations/features.md b/docs/models/operations/features.md index 12ee08a..a2f13ec 100644 --- a/docs/models/operations/features.md +++ b/docs/models/operations/features.md @@ -12,28 +12,43 @@ | `FeaturesTrebleShowFeatures` | TREBLE-show-features | | `FeaturesAdCountdownTimer` | ad-countdown-timer | | `FeaturesAdaptiveBitrate` | adaptive_bitrate | +| `FeaturesAlbumTypes` | album-types | +| `FeaturesAllowDvr` | allow_dvr | | `FeaturesAmazonLoopDebug` | amazon-loop-debug | | `FeaturesAvodAdAnalysis` | avod-ad-analysis | | `FeaturesAvodNewMedia` | avod-new-media | | `FeaturesBlacklistGetSignin` | blacklist_get_signin | +| `FeaturesBoostVoices` | boost-voices | +| `FeaturesCameraUpload` | camera_upload | | `FeaturesClientRadioStations` | client-radio-stations | | `FeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required | +| `FeaturesCloudsync` | cloudsync | | `FeaturesCollections` | collections | | `FeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications | | `FeaturesCommunityAccessPlexTv` | community_access_plex_tv | | `FeaturesCompanionsSonos` | companions_sonos | +| `FeaturesContentFilter` | content_filter | | `FeaturesCustomHomeRemoval` | custom-home-removal | | `FeaturesDisableHomeUserFriendships` | disable_home_user_friendships | | `FeaturesDisableSharingFriendships` | disable_sharing_friendships | +| `FeaturesDownloadsGating` | downloads-gating | | `FeaturesDrmSupport` | drm_support | +| `FeaturesDvr` | dvr | +| `FeaturesDvrBlockUnsupportedCountries` | dvr-block-unsupported-countries | +| `FeaturesEpgRecentChannels` | epg-recent-channels | | `FeaturesExcludeRestrictions` | exclude restrictions | | `FeaturesFederatedAuth` | federated-auth | | `FeaturesFriendRequestPushNotifications` | friend_request_push_notifications | +| `FeaturesGrandfatherSync` | grandfather-sync | | `FeaturesGuidedUpgrade` | guided-upgrade | +| `FeaturesHardwareTranscoding` | hardware_transcoding | | `FeaturesHome` | home | +| `FeaturesHwtranscode` | hwtranscode | +| `FeaturesImaggaV2` | imagga-v2 | | `FeaturesIncreasePasswordComplexity` | increase-password-complexity | | `FeaturesIos14PrivacyBanner` | ios14-privacy-banner | | `FeaturesIterableNotificationTokens` | iterable-notification-tokens | +| `FeaturesItemClusters` | item_clusters | | `FeaturesKeepPaymentMethod` | keep-payment-method | | `FeaturesKevinBacon` | kevin-bacon | | `FeaturesKoreaConsent` | korea-consent | @@ -42,25 +57,46 @@ | `FeaturesLightningDvrPivot` | lightning-dvr-pivot | | `FeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments | | `FeaturesLivetv` | livetv | +| `FeaturesLyrics` | lyrics | | `FeaturesMetadataSearch` | metadata_search | +| `FeaturesMusicAnalysis` | music-analysis | +| `FeaturesMusicVideos` | music_videos | | `FeaturesNewPlexPassPrices` | new_plex_pass_prices | | `FeaturesNewsProviderSunsetModal` | news-provider-sunset-modal | +| `FeaturesNominatim` | nominatim | +| `FeaturesPass` | pass | | `FeaturesPhotosFavorites` | photos-favorites | | `FeaturesPhotosMetadataEdition` | photos-metadata-edition | +| `FeaturesPhotosV6Edit` | photosV6-edit | +| `FeaturesPhotosV6TvAlbums` | photosV6-tv-albums | | `FeaturesPmsHealth` | pms_health | +| `FeaturesPremiumDashboard` | premium-dashboard | +| `FeaturesPremiumMusicMetadata` | premium_music_metadata | | `FeaturesRadio` | radio | | `FeaturesRateLimitClientToken` | rate-limit-client-token | | `FeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv | +| `FeaturesSessionBandwidthRestrictions` | session_bandwidth_restrictions | +| `FeaturesSessionKick` | session_kick | | `FeaturesSharedServerNotification` | shared_server_notification | | `FeaturesSharedSourceNotification` | shared_source_notification | +| `FeaturesSigninNotification` | signin_notification | | `FeaturesSigninWithApple` | signin_with_apple | +| `FeaturesSilenceRemoval` | silence-removal | +| `FeaturesSleepTimer` | sleep-timer | | `FeaturesSpringServeAdProvider` | spring_serve_ad_provider | +| `FeaturesSync` | sync | +| `FeaturesSweetFades` | sweet-fades | | `FeaturesTranscoderCache` | transcoder_cache | +| `FeaturesTrailers` | trailers | | `FeaturesTunerSharing` | tuner-sharing | | `FeaturesTwoFactorAuthentication` | two-factor-authentication | | `FeaturesUnsupportedtuners` | unsupportedtuners | | `FeaturesUpgrade3ds2` | upgrade-3ds2 | +| `FeaturesVisualizers` | visualizers | | `FeaturesVodSchema` | vod-schema | | `FeaturesVodCloudflare` | vod_cloudflare | +| `FeaturesVolumeLeveling` | volume-leveling | | `FeaturesWatchTogetherInvite` | watch-together-invite | -| `FeaturesWebServerDashboard` | web_server_dashboard | \ No newline at end of file +| `FeaturesWatchlistRss` | watchlist-rss | +| `FeaturesWebServerDashboard` | web_server_dashboard | +| `FeaturesWebhooks` | webhooks | \ No newline at end of file diff --git a/docs/models/operations/getpinglobals.md b/docs/models/operations/getpinglobals.md index 6d66b4f..01eb2f7 100644 --- a/docs/models/operations/getpinglobals.md +++ b/docs/models/operations/getpinglobals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | -| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | -| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | -| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/getpinrequest.md b/docs/models/operations/getpinrequest.md index 10b79c2..2fc5f3c 100644 --- a/docs/models/operations/getpinrequest.md +++ b/docs/models/operations/getpinrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Strong` | **bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | -| `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 | -| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | -| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | -| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | -| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Strong` | **bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/getserverresourcesglobals.md b/docs/models/operations/getserverresourcesglobals.md new file mode 100644 index 0000000..8059ad2 --- /dev/null +++ b/docs/models/operations/getserverresourcesglobals.md @@ -0,0 +1,8 @@ +# GetServerResourcesGlobals + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | \ No newline at end of file diff --git a/docs/models/operations/getserverresourcesrequest.md b/docs/models/operations/getserverresourcesrequest.md index 9e4aff7..4156078 100644 --- a/docs/models/operations/getserverresourcesrequest.md +++ b/docs/models/operations/getserverresourcesrequest.md @@ -3,8 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `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
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 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 | \ No newline at end of file diff --git a/docs/models/operations/gettokenbypinidglobals.md b/docs/models/operations/gettokenbypinidglobals.md new file mode 100644 index 0000000..cfe6698 --- /dev/null +++ b/docs/models/operations/gettokenbypinidglobals.md @@ -0,0 +1,12 @@ +# GetTokenByPinIDGlobals + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/gettokenbypinidrequest.md b/docs/models/operations/gettokenbypinidrequest.md index 1ed6acd..e4353c3 100644 --- a/docs/models/operations/gettokenbypinidrequest.md +++ b/docs/models/operations/gettokenbypinidrequest.md @@ -3,6 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/gettokendetailsfeatures.md b/docs/models/operations/gettokendetailsfeatures.md index 50c8f23..21f5c58 100644 --- a/docs/models/operations/gettokendetailsfeatures.md +++ b/docs/models/operations/gettokendetailsfeatures.md @@ -12,28 +12,43 @@ | `GetTokenDetailsFeaturesTrebleShowFeatures` | TREBLE-show-features | | `GetTokenDetailsFeaturesAdCountdownTimer` | ad-countdown-timer | | `GetTokenDetailsFeaturesAdaptiveBitrate` | adaptive_bitrate | +| `GetTokenDetailsFeaturesAlbumTypes` | album-types | +| `GetTokenDetailsFeaturesAllowDvr` | allow_dvr | | `GetTokenDetailsFeaturesAmazonLoopDebug` | amazon-loop-debug | | `GetTokenDetailsFeaturesAvodAdAnalysis` | avod-ad-analysis | | `GetTokenDetailsFeaturesAvodNewMedia` | avod-new-media | | `GetTokenDetailsFeaturesBlacklistGetSignin` | blacklist_get_signin | +| `GetTokenDetailsFeaturesBoostVoices` | boost-voices | +| `GetTokenDetailsFeaturesCameraUpload` | camera_upload | | `GetTokenDetailsFeaturesClientRadioStations` | client-radio-stations | | `GetTokenDetailsFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required | +| `GetTokenDetailsFeaturesCloudsync` | cloudsync | | `GetTokenDetailsFeaturesCollections` | collections | | `GetTokenDetailsFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications | | `GetTokenDetailsFeaturesCommunityAccessPlexTv` | community_access_plex_tv | | `GetTokenDetailsFeaturesCompanionsSonos` | companions_sonos | +| `GetTokenDetailsFeaturesContentFilter` | content_filter | | `GetTokenDetailsFeaturesCustomHomeRemoval` | custom-home-removal | | `GetTokenDetailsFeaturesDisableHomeUserFriendships` | disable_home_user_friendships | | `GetTokenDetailsFeaturesDisableSharingFriendships` | disable_sharing_friendships | +| `GetTokenDetailsFeaturesDownloadsGating` | downloads-gating | | `GetTokenDetailsFeaturesDrmSupport` | drm_support | +| `GetTokenDetailsFeaturesDvr` | dvr | +| `GetTokenDetailsFeaturesDvrBlockUnsupportedCountries` | dvr-block-unsupported-countries | +| `GetTokenDetailsFeaturesEpgRecentChannels` | epg-recent-channels | | `GetTokenDetailsFeaturesExcludeRestrictions` | exclude restrictions | | `GetTokenDetailsFeaturesFederatedAuth` | federated-auth | | `GetTokenDetailsFeaturesFriendRequestPushNotifications` | friend_request_push_notifications | +| `GetTokenDetailsFeaturesGrandfatherSync` | grandfather-sync | | `GetTokenDetailsFeaturesGuidedUpgrade` | guided-upgrade | +| `GetTokenDetailsFeaturesHardwareTranscoding` | hardware_transcoding | | `GetTokenDetailsFeaturesHome` | home | +| `GetTokenDetailsFeaturesHwtranscode` | hwtranscode | +| `GetTokenDetailsFeaturesImaggaV2` | imagga-v2 | | `GetTokenDetailsFeaturesIncreasePasswordComplexity` | increase-password-complexity | | `GetTokenDetailsFeaturesIos14PrivacyBanner` | ios14-privacy-banner | | `GetTokenDetailsFeaturesIterableNotificationTokens` | iterable-notification-tokens | +| `GetTokenDetailsFeaturesItemClusters` | item_clusters | | `GetTokenDetailsFeaturesKeepPaymentMethod` | keep-payment-method | | `GetTokenDetailsFeaturesKevinBacon` | kevin-bacon | | `GetTokenDetailsFeaturesKoreaConsent` | korea-consent | @@ -42,25 +57,46 @@ | `GetTokenDetailsFeaturesLightningDvrPivot` | lightning-dvr-pivot | | `GetTokenDetailsFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments | | `GetTokenDetailsFeaturesLivetv` | livetv | +| `GetTokenDetailsFeaturesLyrics` | lyrics | | `GetTokenDetailsFeaturesMetadataSearch` | metadata_search | +| `GetTokenDetailsFeaturesMusicAnalysis` | music-analysis | +| `GetTokenDetailsFeaturesMusicVideos` | music_videos | | `GetTokenDetailsFeaturesNewPlexPassPrices` | new_plex_pass_prices | | `GetTokenDetailsFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal | +| `GetTokenDetailsFeaturesNominatim` | nominatim | +| `GetTokenDetailsFeaturesPass` | pass | | `GetTokenDetailsFeaturesPhotosFavorites` | photos-favorites | | `GetTokenDetailsFeaturesPhotosMetadataEdition` | photos-metadata-edition | +| `GetTokenDetailsFeaturesPhotosV6Edit` | photosV6-edit | +| `GetTokenDetailsFeaturesPhotosV6TvAlbums` | photosV6-tv-albums | | `GetTokenDetailsFeaturesPmsHealth` | pms_health | +| `GetTokenDetailsFeaturesPremiumDashboard` | premium-dashboard | +| `GetTokenDetailsFeaturesPremiumMusicMetadata` | premium_music_metadata | | `GetTokenDetailsFeaturesRadio` | radio | | `GetTokenDetailsFeaturesRateLimitClientToken` | rate-limit-client-token | | `GetTokenDetailsFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv | +| `GetTokenDetailsFeaturesSessionBandwidthRestrictions` | session_bandwidth_restrictions | +| `GetTokenDetailsFeaturesSessionKick` | session_kick | | `GetTokenDetailsFeaturesSharedServerNotification` | shared_server_notification | | `GetTokenDetailsFeaturesSharedSourceNotification` | shared_source_notification | +| `GetTokenDetailsFeaturesSigninNotification` | signin_notification | | `GetTokenDetailsFeaturesSigninWithApple` | signin_with_apple | +| `GetTokenDetailsFeaturesSilenceRemoval` | silence-removal | +| `GetTokenDetailsFeaturesSleepTimer` | sleep-timer | | `GetTokenDetailsFeaturesSpringServeAdProvider` | spring_serve_ad_provider | +| `GetTokenDetailsFeaturesSync` | sync | +| `GetTokenDetailsFeaturesSweetFades` | sweet-fades | | `GetTokenDetailsFeaturesTranscoderCache` | transcoder_cache | +| `GetTokenDetailsFeaturesTrailers` | trailers | | `GetTokenDetailsFeaturesTunerSharing` | tuner-sharing | | `GetTokenDetailsFeaturesTwoFactorAuthentication` | two-factor-authentication | | `GetTokenDetailsFeaturesUnsupportedtuners` | unsupportedtuners | | `GetTokenDetailsFeaturesUpgrade3ds2` | upgrade-3ds2 | +| `GetTokenDetailsFeaturesVisualizers` | visualizers | | `GetTokenDetailsFeaturesVodSchema` | vod-schema | | `GetTokenDetailsFeaturesVodCloudflare` | vod_cloudflare | +| `GetTokenDetailsFeaturesVolumeLeveling` | volume-leveling | | `GetTokenDetailsFeaturesWatchTogetherInvite` | watch-together-invite | -| `GetTokenDetailsFeaturesWebServerDashboard` | web_server_dashboard | \ No newline at end of file +| `GetTokenDetailsFeaturesWatchlistRss` | watchlist-rss | +| `GetTokenDetailsFeaturesWebServerDashboard` | web_server_dashboard | +| `GetTokenDetailsFeaturesWebhooks` | webhooks | \ No newline at end of file diff --git a/docs/models/operations/gettokendetailsuserplexaccount.md b/docs/models/operations/gettokendetailsuserplexaccount.md index e4d5227..4cb5c08 100644 --- a/docs/models/operations/gettokendetailsuserplexaccount.md +++ b/docs/models/operations/gettokendetailsuserplexaccount.md @@ -29,7 +29,7 @@ Logged in user details | `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `Locale` | *string* | :heavy_check_mark: | The account locale | | | `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | | -| `MailingListStatus` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | | +| `MailingListStatus` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active | | `MaxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 | | ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

[Might be removed] The hashed Plex Home PIN | | | `Profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | | diff --git a/docs/models/operations/mailingliststatus.md b/docs/models/operations/mailingliststatus.md index 4f2444a..762ca3e 100644 --- a/docs/models/operations/mailingliststatus.md +++ b/docs/models/operations/mailingliststatus.md @@ -1,6 +1,6 @@ # MailingListStatus -Your current mailing list status +Your current mailing list status (active or unsubscribed) ## Values diff --git a/docs/models/operations/postuserssignindataauthenticationfeatures.md b/docs/models/operations/postuserssignindataauthenticationfeatures.md index b628914..9c543d7 100644 --- a/docs/models/operations/postuserssignindataauthenticationfeatures.md +++ b/docs/models/operations/postuserssignindataauthenticationfeatures.md @@ -12,28 +12,43 @@ | `PostUsersSignInDataAuthenticationFeaturesTrebleShowFeatures` | TREBLE-show-features | | `PostUsersSignInDataAuthenticationFeaturesAdCountdownTimer` | ad-countdown-timer | | `PostUsersSignInDataAuthenticationFeaturesAdaptiveBitrate` | adaptive_bitrate | +| `PostUsersSignInDataAuthenticationFeaturesAlbumTypes` | album-types | +| `PostUsersSignInDataAuthenticationFeaturesAllowDvr` | allow_dvr | | `PostUsersSignInDataAuthenticationFeaturesAmazonLoopDebug` | amazon-loop-debug | | `PostUsersSignInDataAuthenticationFeaturesAvodAdAnalysis` | avod-ad-analysis | | `PostUsersSignInDataAuthenticationFeaturesAvodNewMedia` | avod-new-media | | `PostUsersSignInDataAuthenticationFeaturesBlacklistGetSignin` | blacklist_get_signin | +| `PostUsersSignInDataAuthenticationFeaturesBoostVoices` | boost-voices | +| `PostUsersSignInDataAuthenticationFeaturesCameraUpload` | camera_upload | | `PostUsersSignInDataAuthenticationFeaturesClientRadioStations` | client-radio-stations | | `PostUsersSignInDataAuthenticationFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required | +| `PostUsersSignInDataAuthenticationFeaturesCloudsync` | cloudsync | | `PostUsersSignInDataAuthenticationFeaturesCollections` | collections | | `PostUsersSignInDataAuthenticationFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications | | `PostUsersSignInDataAuthenticationFeaturesCommunityAccessPlexTv` | community_access_plex_tv | | `PostUsersSignInDataAuthenticationFeaturesCompanionsSonos` | companions_sonos | +| `PostUsersSignInDataAuthenticationFeaturesContentFilter` | content_filter | | `PostUsersSignInDataAuthenticationFeaturesCustomHomeRemoval` | custom-home-removal | | `PostUsersSignInDataAuthenticationFeaturesDisableHomeUserFriendships` | disable_home_user_friendships | | `PostUsersSignInDataAuthenticationFeaturesDisableSharingFriendships` | disable_sharing_friendships | +| `PostUsersSignInDataAuthenticationFeaturesDownloadsGating` | downloads-gating | | `PostUsersSignInDataAuthenticationFeaturesDrmSupport` | drm_support | +| `PostUsersSignInDataAuthenticationFeaturesDvr` | dvr | +| `PostUsersSignInDataAuthenticationFeaturesDvrBlockUnsupportedCountries` | dvr-block-unsupported-countries | +| `PostUsersSignInDataAuthenticationFeaturesEpgRecentChannels` | epg-recent-channels | | `PostUsersSignInDataAuthenticationFeaturesExcludeRestrictions` | exclude restrictions | | `PostUsersSignInDataAuthenticationFeaturesFederatedAuth` | federated-auth | | `PostUsersSignInDataAuthenticationFeaturesFriendRequestPushNotifications` | friend_request_push_notifications | +| `PostUsersSignInDataAuthenticationFeaturesGrandfatherSync` | grandfather-sync | | `PostUsersSignInDataAuthenticationFeaturesGuidedUpgrade` | guided-upgrade | +| `PostUsersSignInDataAuthenticationFeaturesHardwareTranscoding` | hardware_transcoding | | `PostUsersSignInDataAuthenticationFeaturesHome` | home | +| `PostUsersSignInDataAuthenticationFeaturesHwtranscode` | hwtranscode | +| `PostUsersSignInDataAuthenticationFeaturesImaggaV2` | imagga-v2 | | `PostUsersSignInDataAuthenticationFeaturesIncreasePasswordComplexity` | increase-password-complexity | | `PostUsersSignInDataAuthenticationFeaturesIos14PrivacyBanner` | ios14-privacy-banner | | `PostUsersSignInDataAuthenticationFeaturesIterableNotificationTokens` | iterable-notification-tokens | +| `PostUsersSignInDataAuthenticationFeaturesItemClusters` | item_clusters | | `PostUsersSignInDataAuthenticationFeaturesKeepPaymentMethod` | keep-payment-method | | `PostUsersSignInDataAuthenticationFeaturesKevinBacon` | kevin-bacon | | `PostUsersSignInDataAuthenticationFeaturesKoreaConsent` | korea-consent | @@ -42,25 +57,46 @@ | `PostUsersSignInDataAuthenticationFeaturesLightningDvrPivot` | lightning-dvr-pivot | | `PostUsersSignInDataAuthenticationFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments | | `PostUsersSignInDataAuthenticationFeaturesLivetv` | livetv | +| `PostUsersSignInDataAuthenticationFeaturesLyrics` | lyrics | | `PostUsersSignInDataAuthenticationFeaturesMetadataSearch` | metadata_search | +| `PostUsersSignInDataAuthenticationFeaturesMusicAnalysis` | music-analysis | +| `PostUsersSignInDataAuthenticationFeaturesMusicVideos` | music_videos | | `PostUsersSignInDataAuthenticationFeaturesNewPlexPassPrices` | new_plex_pass_prices | | `PostUsersSignInDataAuthenticationFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal | +| `PostUsersSignInDataAuthenticationFeaturesNominatim` | nominatim | +| `PostUsersSignInDataAuthenticationFeaturesPass` | pass | | `PostUsersSignInDataAuthenticationFeaturesPhotosFavorites` | photos-favorites | | `PostUsersSignInDataAuthenticationFeaturesPhotosMetadataEdition` | photos-metadata-edition | +| `PostUsersSignInDataAuthenticationFeaturesPhotosV6Edit` | photosV6-edit | +| `PostUsersSignInDataAuthenticationFeaturesPhotosV6TvAlbums` | photosV6-tv-albums | | `PostUsersSignInDataAuthenticationFeaturesPmsHealth` | pms_health | +| `PostUsersSignInDataAuthenticationFeaturesPremiumDashboard` | premium-dashboard | +| `PostUsersSignInDataAuthenticationFeaturesPremiumMusicMetadata` | premium_music_metadata | | `PostUsersSignInDataAuthenticationFeaturesRadio` | radio | | `PostUsersSignInDataAuthenticationFeaturesRateLimitClientToken` | rate-limit-client-token | | `PostUsersSignInDataAuthenticationFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv | +| `PostUsersSignInDataAuthenticationFeaturesSessionBandwidthRestrictions` | session_bandwidth_restrictions | +| `PostUsersSignInDataAuthenticationFeaturesSessionKick` | session_kick | | `PostUsersSignInDataAuthenticationFeaturesSharedServerNotification` | shared_server_notification | | `PostUsersSignInDataAuthenticationFeaturesSharedSourceNotification` | shared_source_notification | +| `PostUsersSignInDataAuthenticationFeaturesSigninNotification` | signin_notification | | `PostUsersSignInDataAuthenticationFeaturesSigninWithApple` | signin_with_apple | +| `PostUsersSignInDataAuthenticationFeaturesSilenceRemoval` | silence-removal | +| `PostUsersSignInDataAuthenticationFeaturesSleepTimer` | sleep-timer | | `PostUsersSignInDataAuthenticationFeaturesSpringServeAdProvider` | spring_serve_ad_provider | +| `PostUsersSignInDataAuthenticationFeaturesSync` | sync | +| `PostUsersSignInDataAuthenticationFeaturesSweetFades` | sweet-fades | | `PostUsersSignInDataAuthenticationFeaturesTranscoderCache` | transcoder_cache | +| `PostUsersSignInDataAuthenticationFeaturesTrailers` | trailers | | `PostUsersSignInDataAuthenticationFeaturesTunerSharing` | tuner-sharing | | `PostUsersSignInDataAuthenticationFeaturesTwoFactorAuthentication` | two-factor-authentication | | `PostUsersSignInDataAuthenticationFeaturesUnsupportedtuners` | unsupportedtuners | | `PostUsersSignInDataAuthenticationFeaturesUpgrade3ds2` | upgrade-3ds2 | +| `PostUsersSignInDataAuthenticationFeaturesVisualizers` | visualizers | | `PostUsersSignInDataAuthenticationFeaturesVodSchema` | vod-schema | | `PostUsersSignInDataAuthenticationFeaturesVodCloudflare` | vod_cloudflare | +| `PostUsersSignInDataAuthenticationFeaturesVolumeLeveling` | volume-leveling | | `PostUsersSignInDataAuthenticationFeaturesWatchTogetherInvite` | watch-together-invite | -| `PostUsersSignInDataAuthenticationFeaturesWebServerDashboard` | web_server_dashboard | \ No newline at end of file +| `PostUsersSignInDataAuthenticationFeaturesWatchlistRss` | watchlist-rss | +| `PostUsersSignInDataAuthenticationFeaturesWebServerDashboard` | web_server_dashboard | +| `PostUsersSignInDataAuthenticationFeaturesWebhooks` | webhooks | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindatafeatures.md b/docs/models/operations/postuserssignindatafeatures.md index e19d812..7c5b11c 100644 --- a/docs/models/operations/postuserssignindatafeatures.md +++ b/docs/models/operations/postuserssignindatafeatures.md @@ -12,28 +12,43 @@ | `PostUsersSignInDataFeaturesTrebleShowFeatures` | TREBLE-show-features | | `PostUsersSignInDataFeaturesAdCountdownTimer` | ad-countdown-timer | | `PostUsersSignInDataFeaturesAdaptiveBitrate` | adaptive_bitrate | +| `PostUsersSignInDataFeaturesAlbumTypes` | album-types | +| `PostUsersSignInDataFeaturesAllowDvr` | allow_dvr | | `PostUsersSignInDataFeaturesAmazonLoopDebug` | amazon-loop-debug | | `PostUsersSignInDataFeaturesAvodAdAnalysis` | avod-ad-analysis | | `PostUsersSignInDataFeaturesAvodNewMedia` | avod-new-media | | `PostUsersSignInDataFeaturesBlacklistGetSignin` | blacklist_get_signin | +| `PostUsersSignInDataFeaturesBoostVoices` | boost-voices | +| `PostUsersSignInDataFeaturesCameraUpload` | camera_upload | | `PostUsersSignInDataFeaturesClientRadioStations` | client-radio-stations | | `PostUsersSignInDataFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required | +| `PostUsersSignInDataFeaturesCloudsync` | cloudsync | | `PostUsersSignInDataFeaturesCollections` | collections | | `PostUsersSignInDataFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications | | `PostUsersSignInDataFeaturesCommunityAccessPlexTv` | community_access_plex_tv | | `PostUsersSignInDataFeaturesCompanionsSonos` | companions_sonos | +| `PostUsersSignInDataFeaturesContentFilter` | content_filter | | `PostUsersSignInDataFeaturesCustomHomeRemoval` | custom-home-removal | | `PostUsersSignInDataFeaturesDisableHomeUserFriendships` | disable_home_user_friendships | | `PostUsersSignInDataFeaturesDisableSharingFriendships` | disable_sharing_friendships | +| `PostUsersSignInDataFeaturesDownloadsGating` | downloads-gating | | `PostUsersSignInDataFeaturesDrmSupport` | drm_support | +| `PostUsersSignInDataFeaturesDvr` | dvr | +| `PostUsersSignInDataFeaturesDvrBlockUnsupportedCountries` | dvr-block-unsupported-countries | +| `PostUsersSignInDataFeaturesEpgRecentChannels` | epg-recent-channels | | `PostUsersSignInDataFeaturesExcludeRestrictions` | exclude restrictions | | `PostUsersSignInDataFeaturesFederatedAuth` | federated-auth | | `PostUsersSignInDataFeaturesFriendRequestPushNotifications` | friend_request_push_notifications | +| `PostUsersSignInDataFeaturesGrandfatherSync` | grandfather-sync | | `PostUsersSignInDataFeaturesGuidedUpgrade` | guided-upgrade | +| `PostUsersSignInDataFeaturesHardwareTranscoding` | hardware_transcoding | | `PostUsersSignInDataFeaturesHome` | home | +| `PostUsersSignInDataFeaturesHwtranscode` | hwtranscode | +| `PostUsersSignInDataFeaturesImaggaV2` | imagga-v2 | | `PostUsersSignInDataFeaturesIncreasePasswordComplexity` | increase-password-complexity | | `PostUsersSignInDataFeaturesIos14PrivacyBanner` | ios14-privacy-banner | | `PostUsersSignInDataFeaturesIterableNotificationTokens` | iterable-notification-tokens | +| `PostUsersSignInDataFeaturesItemClusters` | item_clusters | | `PostUsersSignInDataFeaturesKeepPaymentMethod` | keep-payment-method | | `PostUsersSignInDataFeaturesKevinBacon` | kevin-bacon | | `PostUsersSignInDataFeaturesKoreaConsent` | korea-consent | @@ -42,25 +57,46 @@ | `PostUsersSignInDataFeaturesLightningDvrPivot` | lightning-dvr-pivot | | `PostUsersSignInDataFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments | | `PostUsersSignInDataFeaturesLivetv` | livetv | +| `PostUsersSignInDataFeaturesLyrics` | lyrics | | `PostUsersSignInDataFeaturesMetadataSearch` | metadata_search | +| `PostUsersSignInDataFeaturesMusicAnalysis` | music-analysis | +| `PostUsersSignInDataFeaturesMusicVideos` | music_videos | | `PostUsersSignInDataFeaturesNewPlexPassPrices` | new_plex_pass_prices | | `PostUsersSignInDataFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal | +| `PostUsersSignInDataFeaturesNominatim` | nominatim | +| `PostUsersSignInDataFeaturesPass` | pass | | `PostUsersSignInDataFeaturesPhotosFavorites` | photos-favorites | | `PostUsersSignInDataFeaturesPhotosMetadataEdition` | photos-metadata-edition | +| `PostUsersSignInDataFeaturesPhotosV6Edit` | photosV6-edit | +| `PostUsersSignInDataFeaturesPhotosV6TvAlbums` | photosV6-tv-albums | | `PostUsersSignInDataFeaturesPmsHealth` | pms_health | +| `PostUsersSignInDataFeaturesPremiumDashboard` | premium-dashboard | +| `PostUsersSignInDataFeaturesPremiumMusicMetadata` | premium_music_metadata | | `PostUsersSignInDataFeaturesRadio` | radio | | `PostUsersSignInDataFeaturesRateLimitClientToken` | rate-limit-client-token | | `PostUsersSignInDataFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv | +| `PostUsersSignInDataFeaturesSessionBandwidthRestrictions` | session_bandwidth_restrictions | +| `PostUsersSignInDataFeaturesSessionKick` | session_kick | | `PostUsersSignInDataFeaturesSharedServerNotification` | shared_server_notification | | `PostUsersSignInDataFeaturesSharedSourceNotification` | shared_source_notification | +| `PostUsersSignInDataFeaturesSigninNotification` | signin_notification | | `PostUsersSignInDataFeaturesSigninWithApple` | signin_with_apple | +| `PostUsersSignInDataFeaturesSilenceRemoval` | silence-removal | +| `PostUsersSignInDataFeaturesSleepTimer` | sleep-timer | | `PostUsersSignInDataFeaturesSpringServeAdProvider` | spring_serve_ad_provider | +| `PostUsersSignInDataFeaturesSync` | sync | +| `PostUsersSignInDataFeaturesSweetFades` | sweet-fades | | `PostUsersSignInDataFeaturesTranscoderCache` | transcoder_cache | +| `PostUsersSignInDataFeaturesTrailers` | trailers | | `PostUsersSignInDataFeaturesTunerSharing` | tuner-sharing | | `PostUsersSignInDataFeaturesTwoFactorAuthentication` | two-factor-authentication | | `PostUsersSignInDataFeaturesUnsupportedtuners` | unsupportedtuners | | `PostUsersSignInDataFeaturesUpgrade3ds2` | upgrade-3ds2 | +| `PostUsersSignInDataFeaturesVisualizers` | visualizers | | `PostUsersSignInDataFeaturesVodSchema` | vod-schema | | `PostUsersSignInDataFeaturesVodCloudflare` | vod_cloudflare | +| `PostUsersSignInDataFeaturesVolumeLeveling` | volume-leveling | | `PostUsersSignInDataFeaturesWatchTogetherInvite` | watch-together-invite | -| `PostUsersSignInDataFeaturesWebServerDashboard` | web_server_dashboard | \ No newline at end of file +| `PostUsersSignInDataFeaturesWatchlistRss` | watchlist-rss | +| `PostUsersSignInDataFeaturesWebServerDashboard` | web_server_dashboard | +| `PostUsersSignInDataFeaturesWebhooks` | webhooks | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindataglobals.md b/docs/models/operations/postuserssignindataglobals.md index 596c01a..01a33f5 100644 --- a/docs/models/operations/postuserssignindataglobals.md +++ b/docs/models/operations/postuserssignindataglobals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | -| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | -| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | -| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindatamailingliststatus.md b/docs/models/operations/postuserssignindatamailingliststatus.md index 40752d3..259453d 100644 --- a/docs/models/operations/postuserssignindatamailingliststatus.md +++ b/docs/models/operations/postuserssignindatamailingliststatus.md @@ -1,6 +1,6 @@ # PostUsersSignInDataMailingListStatus -Your current mailing list status +Your current mailing list status (active or unsubscribed) ## Values diff --git a/docs/models/operations/postuserssignindatarequest.md b/docs/models/operations/postuserssignindatarequest.md index fa8262a..0ec2869 100644 --- a/docs/models/operations/postuserssignindatarequest.md +++ b/docs/models/operations/postuserssignindatarequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | -| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | -| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | -| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | -| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | -| `RequestBody` | [*operations.PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | +| `ClientName` | **string* | :heavy_minus_sign: | N/A | Plex Web | +| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux | +| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 | +| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome | +| `RequestBody` | [*operations.PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindatauserplexaccount.md b/docs/models/operations/postuserssignindatauserplexaccount.md index f944319..d93fe55 100644 --- a/docs/models/operations/postuserssignindatauserplexaccount.md +++ b/docs/models/operations/postuserssignindatauserplexaccount.md @@ -29,7 +29,7 @@ Returns the user account data with a valid auth token | `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `Locale` | *string* | :heavy_check_mark: | The account locale | | | `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | | -| `MailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | | +| `MailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active | | `MaxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 | | ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

[Might be removed] The hashed Plex Home PIN | | | `Profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | | diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 3453ee1..e6b23a4 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md index 498fc32..c779382 100644 --- a/docs/sdks/authentication/README.md +++ b/docs/sdks/authentication/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/butler/README.md b/docs/sdks/butler/README.md index b144391..dd1b1f4 100644 --- a/docs/sdks/butler/README.md +++ b/docs/sdks/butler/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/hubs/README.md b/docs/sdks/hubs/README.md index bd78525..a454a48 100644 --- a/docs/sdks/hubs/README.md +++ b/docs/sdks/hubs/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md index 5f86a14..7a9afe7 100644 --- a/docs/sdks/library/README.md +++ b/docs/sdks/library/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md index 6168d95..d523c24 100644 --- a/docs/sdks/log/README.md +++ b/docs/sdks/log/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/media/README.md b/docs/sdks/media/README.md index 1e0af3b..25ff759 100644 --- a/docs/sdks/media/README.md +++ b/docs/sdks/media/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md index adc3c0d..65ca670 100644 --- a/docs/sdks/playlists/README.md +++ b/docs/sdks/playlists/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md index 0119a25..e717e37 100644 --- a/docs/sdks/plex/README.md +++ b/docs/sdks/plex/README.md @@ -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
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 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
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/plexapi/README.md b/docs/sdks/plexapi/README.md index 2fd26ab..1baeb06 100644 --- a/docs/sdks/plexapi/README.md +++ b/docs/sdks/plexapi/README.md @@ -2,4 +2,27 @@ ## Overview -Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server \ No newline at end of file +# 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) | - diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index 03b1ea6..0b4a019 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/server/README.md b/docs/sdks/server/README.md index 1d9932f..f4a5b23 100644 --- a/docs/sdks/server/README.md +++ b/docs/sdks/server/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index adca153..9d705f3 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/statistics/README.md b/docs/sdks/statistics/README.md index 64258e4..1a515fe 100644 --- a/docs/sdks/statistics/README.md +++ b/docs/sdks/statistics/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/updater/README.md b/docs/sdks/updater/README.md index 9d0ed11..cc3306f 100644 --- a/docs/sdks/updater/README.md +++ b/docs/sdks/updater/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/video/README.md b/docs/sdks/video/README.md index 1033782..11cae98 100644 --- a/docs/sdks/video/README.md +++ b/docs/sdks/video/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/docs/sdks/watchlist/README.md b/docs/sdks/watchlist/README.md index 42351f8..4d5b0e7 100644 --- a/docs/sdks/watchlist/README.md +++ b/docs/sdks/watchlist/README.md @@ -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 | \*/\* | \ No newline at end of file diff --git a/internal/globals/globals.go b/internal/globals/globals.go index c2103c9..a323d01 100644 --- a/internal/globals/globals.go +++ b/internal/globals/globals.go @@ -3,10 +3,7 @@ package globals type Globals struct { - // 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) - // + // 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) ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` ClientVersion *string `queryParam:"style=form,explode=true,name=X-Plex-Version"` diff --git a/models/operations/getcompanionsdata.go b/models/operations/getcompanionsdata.go index d2711df..bd69f15 100644 --- a/models/operations/getcompanionsdata.go +++ b/models/operations/getcompanionsdata.go @@ -7,7 +7,7 @@ import ( ) var GetCompanionsDataServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } type ResponseBody struct { diff --git a/models/operations/getgeodata.go b/models/operations/getgeodata.go index 93a48ed..f4b6119 100644 --- a/models/operations/getgeodata.go +++ b/models/operations/getgeodata.go @@ -8,7 +8,7 @@ import ( ) var GetGeoDataServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } // GetGeoDataGeoData - Geo location data diff --git a/models/operations/getpin.go b/models/operations/getpin.go index 878a16f..c61252e 100644 --- a/models/operations/getpin.go +++ b/models/operations/getpin.go @@ -9,14 +9,11 @@ import ( ) var GetPinServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } type GetPinGlobals struct { - // 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) - // + // 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) ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` @@ -65,10 +62,7 @@ type GetPinRequest struct { // Non-Strong codes are used for `Plex.tv/link` // Strong *bool `default:"false" queryParam:"style=form,explode=true,name=strong"` - // 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) - // + // 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) ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` diff --git a/models/operations/getserverresources.go b/models/operations/getserverresources.go index a4e674d..d0bb725 100644 --- a/models/operations/getserverresources.go +++ b/models/operations/getserverresources.go @@ -11,7 +11,19 @@ import ( ) var GetServerResourcesServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", +} + +type GetServerResourcesGlobals struct { + // 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) + ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` +} + +func (o *GetServerResourcesGlobals) GetClientID() *string { + if o == nil { + return nil + } + return o.ClientID } // IncludeHTTPS - Include Https entries in the results @@ -105,6 +117,8 @@ type GetServerResourcesRequest struct { IncludeRelay *IncludeRelay `default:"0" queryParam:"style=form,explode=true,name=includeRelay"` // Include IPv6 entries in the results IncludeIPv6 *IncludeIPv6 `default:"0" queryParam:"style=form,explode=true,name=includeIPv6"` + // 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) + ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` } func (g GetServerResourcesRequest) MarshalJSON() ([]byte, error) { @@ -139,6 +153,13 @@ func (o *GetServerResourcesRequest) GetIncludeIPv6() *IncludeIPv6 { return o.IncludeIPv6 } +func (o *GetServerResourcesRequest) GetClientID() *string { + if o == nil { + return nil + } + return o.ClientID +} + // Protocol - The protocol used for the connection (http, https, etc) type Protocol string diff --git a/models/operations/gettokenbypinid.go b/models/operations/gettokenbypinid.go index a0a74a8..ce9c7f4 100644 --- a/models/operations/gettokenbypinid.go +++ b/models/operations/gettokenbypinid.go @@ -9,12 +9,62 @@ import ( ) var GetTokenByPinIDServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", +} + +type GetTokenByPinIDGlobals struct { + // 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) + ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` + ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` + DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` + ClientVersion *string `queryParam:"style=form,explode=true,name=X-Plex-Version"` + ClientPlatform *string `queryParam:"style=form,explode=true,name=X-Plex-Platform"` +} + +func (o *GetTokenByPinIDGlobals) GetClientID() *string { + if o == nil { + return nil + } + return o.ClientID +} + +func (o *GetTokenByPinIDGlobals) GetClientName() *string { + if o == nil { + return nil + } + return o.ClientName +} + +func (o *GetTokenByPinIDGlobals) GetDeviceName() *string { + if o == nil { + return nil + } + return o.DeviceName +} + +func (o *GetTokenByPinIDGlobals) GetClientVersion() *string { + if o == nil { + return nil + } + return o.ClientVersion +} + +func (o *GetTokenByPinIDGlobals) GetClientPlatform() *string { + if o == nil { + return nil + } + return o.ClientPlatform } type GetTokenByPinIDRequest struct { // The PinID to retrieve an access token for PinID int64 `pathParam:"style=simple,explode=false,name=pinID"` + // 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) + ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` + ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` + DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` + ClientVersion *string `queryParam:"style=form,explode=true,name=X-Plex-Version"` + ClientPlatform *string `queryParam:"style=form,explode=true,name=X-Plex-Platform"` } func (o *GetTokenByPinIDRequest) GetPinID() int64 { @@ -24,6 +74,41 @@ func (o *GetTokenByPinIDRequest) GetPinID() int64 { return o.PinID } +func (o *GetTokenByPinIDRequest) GetClientID() *string { + if o == nil { + return nil + } + return o.ClientID +} + +func (o *GetTokenByPinIDRequest) GetClientName() *string { + if o == nil { + return nil + } + return o.ClientName +} + +func (o *GetTokenByPinIDRequest) GetDeviceName() *string { + if o == nil { + return nil + } + return o.DeviceName +} + +func (o *GetTokenByPinIDRequest) GetClientVersion() *string { + if o == nil { + return nil + } + return o.ClientVersion +} + +func (o *GetTokenByPinIDRequest) GetClientPlatform() *string { + if o == nil { + return nil + } + return o.ClientPlatform +} + // GetTokenByPinIDGeoData - Geo location data type GetTokenByPinIDGeoData struct { // The ISO 3166-1 alpha-2 code of the country. diff --git a/models/operations/gettokendetails.go b/models/operations/gettokendetails.go index 332ca39..6779c63 100644 --- a/models/operations/gettokendetails.go +++ b/models/operations/gettokendetails.go @@ -11,10 +11,10 @@ import ( ) var GetTokenDetailsServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } -// MailingListStatus - Your current mailing list status +// MailingListStatus - Your current mailing list status (active or unsubscribed) type MailingListStatus string const ( @@ -336,28 +336,43 @@ const ( FeaturesTrebleShowFeatures Features = "TREBLE-show-features" FeaturesAdCountdownTimer Features = "ad-countdown-timer" FeaturesAdaptiveBitrate Features = "adaptive_bitrate" + FeaturesAlbumTypes Features = "album-types" + FeaturesAllowDvr Features = "allow_dvr" FeaturesAmazonLoopDebug Features = "amazon-loop-debug" FeaturesAvodAdAnalysis Features = "avod-ad-analysis" FeaturesAvodNewMedia Features = "avod-new-media" FeaturesBlacklistGetSignin Features = "blacklist_get_signin" + FeaturesBoostVoices Features = "boost-voices" + FeaturesCameraUpload Features = "camera_upload" FeaturesClientRadioStations Features = "client-radio-stations" FeaturesCloudflareTurnstileRequired Features = "cloudflare-turnstile-required" + FeaturesCloudsync Features = "cloudsync" FeaturesCollections Features = "collections" FeaturesCommentsAndRepliesPushNotifications Features = "comments_and_replies_push_notifications" FeaturesCommunityAccessPlexTv Features = "community_access_plex_tv" FeaturesCompanionsSonos Features = "companions_sonos" + FeaturesContentFilter Features = "content_filter" FeaturesCustomHomeRemoval Features = "custom-home-removal" FeaturesDisableHomeUserFriendships Features = "disable_home_user_friendships" FeaturesDisableSharingFriendships Features = "disable_sharing_friendships" + FeaturesDownloadsGating Features = "downloads-gating" FeaturesDrmSupport Features = "drm_support" + FeaturesDvr Features = "dvr" + FeaturesDvrBlockUnsupportedCountries Features = "dvr-block-unsupported-countries" + FeaturesEpgRecentChannels Features = "epg-recent-channels" FeaturesExcludeRestrictions Features = "exclude restrictions" FeaturesFederatedAuth Features = "federated-auth" FeaturesFriendRequestPushNotifications Features = "friend_request_push_notifications" + FeaturesGrandfatherSync Features = "grandfather-sync" FeaturesGuidedUpgrade Features = "guided-upgrade" + FeaturesHardwareTranscoding Features = "hardware_transcoding" FeaturesHome Features = "home" + FeaturesHwtranscode Features = "hwtranscode" + FeaturesImaggaV2 Features = "imagga-v2" FeaturesIncreasePasswordComplexity Features = "increase-password-complexity" FeaturesIos14PrivacyBanner Features = "ios14-privacy-banner" FeaturesIterableNotificationTokens Features = "iterable-notification-tokens" + FeaturesItemClusters Features = "item_clusters" FeaturesKeepPaymentMethod Features = "keep-payment-method" FeaturesKevinBacon Features = "kevin-bacon" FeaturesKoreaConsent Features = "korea-consent" @@ -366,162 +381,54 @@ const ( FeaturesLightningDvrPivot Features = "lightning-dvr-pivot" FeaturesLiveTvSupportIncompleteSegments Features = "live-tv-support-incomplete-segments" FeaturesLivetv Features = "livetv" + FeaturesLyrics Features = "lyrics" FeaturesMetadataSearch Features = "metadata_search" + FeaturesMusicAnalysis Features = "music-analysis" + FeaturesMusicVideos Features = "music_videos" FeaturesNewPlexPassPrices Features = "new_plex_pass_prices" FeaturesNewsProviderSunsetModal Features = "news-provider-sunset-modal" + FeaturesNominatim Features = "nominatim" + FeaturesPass Features = "pass" FeaturesPhotosFavorites Features = "photos-favorites" FeaturesPhotosMetadataEdition Features = "photos-metadata-edition" + FeaturesPhotosV6Edit Features = "photosV6-edit" + FeaturesPhotosV6TvAlbums Features = "photosV6-tv-albums" FeaturesPmsHealth Features = "pms_health" + FeaturesPremiumDashboard Features = "premium-dashboard" + FeaturesPremiumMusicMetadata Features = "premium_music_metadata" FeaturesRadio Features = "radio" FeaturesRateLimitClientToken Features = "rate-limit-client-token" FeaturesScrobblingServicePlexTv Features = "scrobbling-service-plex-tv" + FeaturesSessionBandwidthRestrictions Features = "session_bandwidth_restrictions" + FeaturesSessionKick Features = "session_kick" FeaturesSharedServerNotification Features = "shared_server_notification" FeaturesSharedSourceNotification Features = "shared_source_notification" + FeaturesSigninNotification Features = "signin_notification" FeaturesSigninWithApple Features = "signin_with_apple" + FeaturesSilenceRemoval Features = "silence-removal" + FeaturesSleepTimer Features = "sleep-timer" FeaturesSpringServeAdProvider Features = "spring_serve_ad_provider" + FeaturesSync Features = "sync" + FeaturesSweetFades Features = "sweet-fades" FeaturesTranscoderCache Features = "transcoder_cache" + FeaturesTrailers Features = "trailers" FeaturesTunerSharing Features = "tuner-sharing" FeaturesTwoFactorAuthentication Features = "two-factor-authentication" FeaturesUnsupportedtuners Features = "unsupportedtuners" FeaturesUpgrade3ds2 Features = "upgrade-3ds2" + FeaturesVisualizers Features = "visualizers" FeaturesVodSchema Features = "vod-schema" FeaturesVodCloudflare Features = "vod_cloudflare" + FeaturesVolumeLeveling Features = "volume-leveling" FeaturesWatchTogetherInvite Features = "watch-together-invite" + FeaturesWatchlistRss Features = "watchlist-rss" FeaturesWebServerDashboard Features = "web_server_dashboard" + FeaturesWebhooks Features = "webhooks" ) func (e Features) ToPointer() *Features { return &e } -func (e *Features) UnmarshalJSON(data []byte) error { - var v string - if err := json.Unmarshal(data, &v); err != nil { - return err - } - switch v { - case "Android - Dolby Vision": - fallthrough - case "Android - PiP": - fallthrough - case "CU Sunset": - fallthrough - case "HRK_enable_EUR": - fallthrough - case "TREBLE-show-features": - fallthrough - case "ad-countdown-timer": - fallthrough - case "adaptive_bitrate": - fallthrough - case "amazon-loop-debug": - fallthrough - case "avod-ad-analysis": - fallthrough - case "avod-new-media": - fallthrough - case "blacklist_get_signin": - fallthrough - case "client-radio-stations": - fallthrough - case "cloudflare-turnstile-required": - fallthrough - case "collections": - fallthrough - case "comments_and_replies_push_notifications": - fallthrough - case "community_access_plex_tv": - fallthrough - case "companions_sonos": - fallthrough - case "custom-home-removal": - fallthrough - case "disable_home_user_friendships": - fallthrough - case "disable_sharing_friendships": - fallthrough - case "drm_support": - fallthrough - case "exclude restrictions": - fallthrough - case "federated-auth": - fallthrough - case "friend_request_push_notifications": - fallthrough - case "guided-upgrade": - fallthrough - case "home": - fallthrough - case "increase-password-complexity": - fallthrough - case "ios14-privacy-banner": - fallthrough - case "iterable-notification-tokens": - fallthrough - case "keep-payment-method": - fallthrough - case "kevin-bacon": - fallthrough - case "korea-consent": - fallthrough - case "le_isrg_root_x1": - fallthrough - case "lets_encrypt": - fallthrough - case "lightning-dvr-pivot": - fallthrough - case "live-tv-support-incomplete-segments": - fallthrough - case "livetv": - fallthrough - case "metadata_search": - fallthrough - case "new_plex_pass_prices": - fallthrough - case "news-provider-sunset-modal": - fallthrough - case "photos-favorites": - fallthrough - case "photos-metadata-edition": - fallthrough - case "pms_health": - fallthrough - case "radio": - fallthrough - case "rate-limit-client-token": - fallthrough - case "scrobbling-service-plex-tv": - fallthrough - case "shared_server_notification": - fallthrough - case "shared_source_notification": - fallthrough - case "signin_with_apple": - fallthrough - case "spring_serve_ad_provider": - fallthrough - case "transcoder_cache": - fallthrough - case "tuner-sharing": - fallthrough - case "two-factor-authentication": - fallthrough - case "unsupportedtuners": - fallthrough - case "upgrade-3ds2": - fallthrough - case "vod-schema": - fallthrough - case "vod_cloudflare": - fallthrough - case "watch-together-invite": - fallthrough - case "web_server_dashboard": - *e = Features(v) - return nil - default: - return fmt.Errorf("invalid value for Features: %v", v) - } -} // GetTokenDetailsAuthenticationStatus - String representation of subscriptionActive type GetTokenDetailsAuthenticationStatus string @@ -618,28 +525,43 @@ const ( GetTokenDetailsFeaturesTrebleShowFeatures GetTokenDetailsFeatures = "TREBLE-show-features" GetTokenDetailsFeaturesAdCountdownTimer GetTokenDetailsFeatures = "ad-countdown-timer" GetTokenDetailsFeaturesAdaptiveBitrate GetTokenDetailsFeatures = "adaptive_bitrate" + GetTokenDetailsFeaturesAlbumTypes GetTokenDetailsFeatures = "album-types" + GetTokenDetailsFeaturesAllowDvr GetTokenDetailsFeatures = "allow_dvr" GetTokenDetailsFeaturesAmazonLoopDebug GetTokenDetailsFeatures = "amazon-loop-debug" GetTokenDetailsFeaturesAvodAdAnalysis GetTokenDetailsFeatures = "avod-ad-analysis" GetTokenDetailsFeaturesAvodNewMedia GetTokenDetailsFeatures = "avod-new-media" GetTokenDetailsFeaturesBlacklistGetSignin GetTokenDetailsFeatures = "blacklist_get_signin" + GetTokenDetailsFeaturesBoostVoices GetTokenDetailsFeatures = "boost-voices" + GetTokenDetailsFeaturesCameraUpload GetTokenDetailsFeatures = "camera_upload" GetTokenDetailsFeaturesClientRadioStations GetTokenDetailsFeatures = "client-radio-stations" GetTokenDetailsFeaturesCloudflareTurnstileRequired GetTokenDetailsFeatures = "cloudflare-turnstile-required" + GetTokenDetailsFeaturesCloudsync GetTokenDetailsFeatures = "cloudsync" GetTokenDetailsFeaturesCollections GetTokenDetailsFeatures = "collections" GetTokenDetailsFeaturesCommentsAndRepliesPushNotifications GetTokenDetailsFeatures = "comments_and_replies_push_notifications" GetTokenDetailsFeaturesCommunityAccessPlexTv GetTokenDetailsFeatures = "community_access_plex_tv" GetTokenDetailsFeaturesCompanionsSonos GetTokenDetailsFeatures = "companions_sonos" + GetTokenDetailsFeaturesContentFilter GetTokenDetailsFeatures = "content_filter" GetTokenDetailsFeaturesCustomHomeRemoval GetTokenDetailsFeatures = "custom-home-removal" GetTokenDetailsFeaturesDisableHomeUserFriendships GetTokenDetailsFeatures = "disable_home_user_friendships" GetTokenDetailsFeaturesDisableSharingFriendships GetTokenDetailsFeatures = "disable_sharing_friendships" + GetTokenDetailsFeaturesDownloadsGating GetTokenDetailsFeatures = "downloads-gating" GetTokenDetailsFeaturesDrmSupport GetTokenDetailsFeatures = "drm_support" + GetTokenDetailsFeaturesDvr GetTokenDetailsFeatures = "dvr" + GetTokenDetailsFeaturesDvrBlockUnsupportedCountries GetTokenDetailsFeatures = "dvr-block-unsupported-countries" + GetTokenDetailsFeaturesEpgRecentChannels GetTokenDetailsFeatures = "epg-recent-channels" GetTokenDetailsFeaturesExcludeRestrictions GetTokenDetailsFeatures = "exclude restrictions" GetTokenDetailsFeaturesFederatedAuth GetTokenDetailsFeatures = "federated-auth" GetTokenDetailsFeaturesFriendRequestPushNotifications GetTokenDetailsFeatures = "friend_request_push_notifications" + GetTokenDetailsFeaturesGrandfatherSync GetTokenDetailsFeatures = "grandfather-sync" GetTokenDetailsFeaturesGuidedUpgrade GetTokenDetailsFeatures = "guided-upgrade" + GetTokenDetailsFeaturesHardwareTranscoding GetTokenDetailsFeatures = "hardware_transcoding" GetTokenDetailsFeaturesHome GetTokenDetailsFeatures = "home" + GetTokenDetailsFeaturesHwtranscode GetTokenDetailsFeatures = "hwtranscode" + GetTokenDetailsFeaturesImaggaV2 GetTokenDetailsFeatures = "imagga-v2" GetTokenDetailsFeaturesIncreasePasswordComplexity GetTokenDetailsFeatures = "increase-password-complexity" GetTokenDetailsFeaturesIos14PrivacyBanner GetTokenDetailsFeatures = "ios14-privacy-banner" GetTokenDetailsFeaturesIterableNotificationTokens GetTokenDetailsFeatures = "iterable-notification-tokens" + GetTokenDetailsFeaturesItemClusters GetTokenDetailsFeatures = "item_clusters" GetTokenDetailsFeaturesKeepPaymentMethod GetTokenDetailsFeatures = "keep-payment-method" GetTokenDetailsFeaturesKevinBacon GetTokenDetailsFeatures = "kevin-bacon" GetTokenDetailsFeaturesKoreaConsent GetTokenDetailsFeatures = "korea-consent" @@ -648,162 +570,54 @@ const ( GetTokenDetailsFeaturesLightningDvrPivot GetTokenDetailsFeatures = "lightning-dvr-pivot" GetTokenDetailsFeaturesLiveTvSupportIncompleteSegments GetTokenDetailsFeatures = "live-tv-support-incomplete-segments" GetTokenDetailsFeaturesLivetv GetTokenDetailsFeatures = "livetv" + GetTokenDetailsFeaturesLyrics GetTokenDetailsFeatures = "lyrics" GetTokenDetailsFeaturesMetadataSearch GetTokenDetailsFeatures = "metadata_search" + GetTokenDetailsFeaturesMusicAnalysis GetTokenDetailsFeatures = "music-analysis" + GetTokenDetailsFeaturesMusicVideos GetTokenDetailsFeatures = "music_videos" GetTokenDetailsFeaturesNewPlexPassPrices GetTokenDetailsFeatures = "new_plex_pass_prices" GetTokenDetailsFeaturesNewsProviderSunsetModal GetTokenDetailsFeatures = "news-provider-sunset-modal" + GetTokenDetailsFeaturesNominatim GetTokenDetailsFeatures = "nominatim" + GetTokenDetailsFeaturesPass GetTokenDetailsFeatures = "pass" GetTokenDetailsFeaturesPhotosFavorites GetTokenDetailsFeatures = "photos-favorites" GetTokenDetailsFeaturesPhotosMetadataEdition GetTokenDetailsFeatures = "photos-metadata-edition" + GetTokenDetailsFeaturesPhotosV6Edit GetTokenDetailsFeatures = "photosV6-edit" + GetTokenDetailsFeaturesPhotosV6TvAlbums GetTokenDetailsFeatures = "photosV6-tv-albums" GetTokenDetailsFeaturesPmsHealth GetTokenDetailsFeatures = "pms_health" + GetTokenDetailsFeaturesPremiumDashboard GetTokenDetailsFeatures = "premium-dashboard" + GetTokenDetailsFeaturesPremiumMusicMetadata GetTokenDetailsFeatures = "premium_music_metadata" GetTokenDetailsFeaturesRadio GetTokenDetailsFeatures = "radio" GetTokenDetailsFeaturesRateLimitClientToken GetTokenDetailsFeatures = "rate-limit-client-token" GetTokenDetailsFeaturesScrobblingServicePlexTv GetTokenDetailsFeatures = "scrobbling-service-plex-tv" + GetTokenDetailsFeaturesSessionBandwidthRestrictions GetTokenDetailsFeatures = "session_bandwidth_restrictions" + GetTokenDetailsFeaturesSessionKick GetTokenDetailsFeatures = "session_kick" GetTokenDetailsFeaturesSharedServerNotification GetTokenDetailsFeatures = "shared_server_notification" GetTokenDetailsFeaturesSharedSourceNotification GetTokenDetailsFeatures = "shared_source_notification" + GetTokenDetailsFeaturesSigninNotification GetTokenDetailsFeatures = "signin_notification" GetTokenDetailsFeaturesSigninWithApple GetTokenDetailsFeatures = "signin_with_apple" + GetTokenDetailsFeaturesSilenceRemoval GetTokenDetailsFeatures = "silence-removal" + GetTokenDetailsFeaturesSleepTimer GetTokenDetailsFeatures = "sleep-timer" GetTokenDetailsFeaturesSpringServeAdProvider GetTokenDetailsFeatures = "spring_serve_ad_provider" + GetTokenDetailsFeaturesSync GetTokenDetailsFeatures = "sync" + GetTokenDetailsFeaturesSweetFades GetTokenDetailsFeatures = "sweet-fades" GetTokenDetailsFeaturesTranscoderCache GetTokenDetailsFeatures = "transcoder_cache" + GetTokenDetailsFeaturesTrailers GetTokenDetailsFeatures = "trailers" GetTokenDetailsFeaturesTunerSharing GetTokenDetailsFeatures = "tuner-sharing" GetTokenDetailsFeaturesTwoFactorAuthentication GetTokenDetailsFeatures = "two-factor-authentication" GetTokenDetailsFeaturesUnsupportedtuners GetTokenDetailsFeatures = "unsupportedtuners" GetTokenDetailsFeaturesUpgrade3ds2 GetTokenDetailsFeatures = "upgrade-3ds2" + GetTokenDetailsFeaturesVisualizers GetTokenDetailsFeatures = "visualizers" GetTokenDetailsFeaturesVodSchema GetTokenDetailsFeatures = "vod-schema" GetTokenDetailsFeaturesVodCloudflare GetTokenDetailsFeatures = "vod_cloudflare" + GetTokenDetailsFeaturesVolumeLeveling GetTokenDetailsFeatures = "volume-leveling" GetTokenDetailsFeaturesWatchTogetherInvite GetTokenDetailsFeatures = "watch-together-invite" + GetTokenDetailsFeaturesWatchlistRss GetTokenDetailsFeatures = "watchlist-rss" GetTokenDetailsFeaturesWebServerDashboard GetTokenDetailsFeatures = "web_server_dashboard" + GetTokenDetailsFeaturesWebhooks GetTokenDetailsFeatures = "webhooks" ) func (e GetTokenDetailsFeatures) ToPointer() *GetTokenDetailsFeatures { return &e } -func (e *GetTokenDetailsFeatures) UnmarshalJSON(data []byte) error { - var v string - if err := json.Unmarshal(data, &v); err != nil { - return err - } - switch v { - case "Android - Dolby Vision": - fallthrough - case "Android - PiP": - fallthrough - case "CU Sunset": - fallthrough - case "HRK_enable_EUR": - fallthrough - case "TREBLE-show-features": - fallthrough - case "ad-countdown-timer": - fallthrough - case "adaptive_bitrate": - fallthrough - case "amazon-loop-debug": - fallthrough - case "avod-ad-analysis": - fallthrough - case "avod-new-media": - fallthrough - case "blacklist_get_signin": - fallthrough - case "client-radio-stations": - fallthrough - case "cloudflare-turnstile-required": - fallthrough - case "collections": - fallthrough - case "comments_and_replies_push_notifications": - fallthrough - case "community_access_plex_tv": - fallthrough - case "companions_sonos": - fallthrough - case "custom-home-removal": - fallthrough - case "disable_home_user_friendships": - fallthrough - case "disable_sharing_friendships": - fallthrough - case "drm_support": - fallthrough - case "exclude restrictions": - fallthrough - case "federated-auth": - fallthrough - case "friend_request_push_notifications": - fallthrough - case "guided-upgrade": - fallthrough - case "home": - fallthrough - case "increase-password-complexity": - fallthrough - case "ios14-privacy-banner": - fallthrough - case "iterable-notification-tokens": - fallthrough - case "keep-payment-method": - fallthrough - case "kevin-bacon": - fallthrough - case "korea-consent": - fallthrough - case "le_isrg_root_x1": - fallthrough - case "lets_encrypt": - fallthrough - case "lightning-dvr-pivot": - fallthrough - case "live-tv-support-incomplete-segments": - fallthrough - case "livetv": - fallthrough - case "metadata_search": - fallthrough - case "new_plex_pass_prices": - fallthrough - case "news-provider-sunset-modal": - fallthrough - case "photos-favorites": - fallthrough - case "photos-metadata-edition": - fallthrough - case "pms_health": - fallthrough - case "radio": - fallthrough - case "rate-limit-client-token": - fallthrough - case "scrobbling-service-plex-tv": - fallthrough - case "shared_server_notification": - fallthrough - case "shared_source_notification": - fallthrough - case "signin_with_apple": - fallthrough - case "spring_serve_ad_provider": - fallthrough - case "transcoder_cache": - fallthrough - case "tuner-sharing": - fallthrough - case "two-factor-authentication": - fallthrough - case "unsupportedtuners": - fallthrough - case "upgrade-3ds2": - fallthrough - case "vod-schema": - fallthrough - case "vod_cloudflare": - fallthrough - case "watch-together-invite": - fallthrough - case "web_server_dashboard": - *e = GetTokenDetailsFeatures(v) - return nil - default: - return fmt.Errorf("invalid value for GetTokenDetailsFeatures: %v", v) - } -} // GetTokenDetailsAuthenticationResponseStatus - String representation of subscriptionActive type GetTokenDetailsAuthenticationResponseStatus string @@ -935,7 +749,7 @@ type GetTokenDetailsUserPlexAccount struct { Locale *string `json:"locale"` // If you are subscribed to the Plex newsletter MailingListActive *bool `default:"false" json:"mailingListActive"` - // Your current mailing list status + // Your current mailing list status (active or unsubscribed) MailingListStatus MailingListStatus `json:"mailingListStatus"` // The maximum number of accounts allowed in the Plex Home MaxHomeSize int `json:"maxHomeSize"` diff --git a/models/operations/getuserfriends.go b/models/operations/getuserfriends.go index 80c903f..b95d5ee 100644 --- a/models/operations/getuserfriends.go +++ b/models/operations/getuserfriends.go @@ -10,7 +10,7 @@ import ( ) var GetUserFriendsServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } type SharedServers struct { diff --git a/models/operations/postuserssignindata.go b/models/operations/postuserssignindata.go index a42d367..ef9ff57 100644 --- a/models/operations/postuserssignindata.go +++ b/models/operations/postuserssignindata.go @@ -11,14 +11,11 @@ import ( ) var PostUsersSignInDataServerList = []string{ - "https://plex.tv/api/v2/", + "https://plex.tv/api/v2", } type PostUsersSignInDataGlobals struct { - // 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) - // + // 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) ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` @@ -109,10 +106,7 @@ func (o *PostUsersSignInDataRequestBody) GetVerificationCode() *string { } type PostUsersSignInDataRequest struct { - // 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) - // + // 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) ClientID *string `queryParam:"style=form,explode=true,name=X-Plex-Client-Identifier"` ClientName *string `queryParam:"style=form,explode=true,name=X-Plex-Product"` DeviceName *string `queryParam:"style=form,explode=true,name=X-Plex-Device"` @@ -164,7 +158,7 @@ func (o *PostUsersSignInDataRequest) GetRequestBody() *PostUsersSignInDataReques return o.RequestBody } -// PostUsersSignInDataMailingListStatus - Your current mailing list status +// PostUsersSignInDataMailingListStatus - Your current mailing list status (active or unsubscribed) type PostUsersSignInDataMailingListStatus string const ( @@ -486,28 +480,43 @@ const ( PostUsersSignInDataFeaturesTrebleShowFeatures PostUsersSignInDataFeatures = "TREBLE-show-features" PostUsersSignInDataFeaturesAdCountdownTimer PostUsersSignInDataFeatures = "ad-countdown-timer" PostUsersSignInDataFeaturesAdaptiveBitrate PostUsersSignInDataFeatures = "adaptive_bitrate" + PostUsersSignInDataFeaturesAlbumTypes PostUsersSignInDataFeatures = "album-types" + PostUsersSignInDataFeaturesAllowDvr PostUsersSignInDataFeatures = "allow_dvr" PostUsersSignInDataFeaturesAmazonLoopDebug PostUsersSignInDataFeatures = "amazon-loop-debug" PostUsersSignInDataFeaturesAvodAdAnalysis PostUsersSignInDataFeatures = "avod-ad-analysis" PostUsersSignInDataFeaturesAvodNewMedia PostUsersSignInDataFeatures = "avod-new-media" PostUsersSignInDataFeaturesBlacklistGetSignin PostUsersSignInDataFeatures = "blacklist_get_signin" + PostUsersSignInDataFeaturesBoostVoices PostUsersSignInDataFeatures = "boost-voices" + PostUsersSignInDataFeaturesCameraUpload PostUsersSignInDataFeatures = "camera_upload" PostUsersSignInDataFeaturesClientRadioStations PostUsersSignInDataFeatures = "client-radio-stations" PostUsersSignInDataFeaturesCloudflareTurnstileRequired PostUsersSignInDataFeatures = "cloudflare-turnstile-required" + PostUsersSignInDataFeaturesCloudsync PostUsersSignInDataFeatures = "cloudsync" PostUsersSignInDataFeaturesCollections PostUsersSignInDataFeatures = "collections" PostUsersSignInDataFeaturesCommentsAndRepliesPushNotifications PostUsersSignInDataFeatures = "comments_and_replies_push_notifications" PostUsersSignInDataFeaturesCommunityAccessPlexTv PostUsersSignInDataFeatures = "community_access_plex_tv" PostUsersSignInDataFeaturesCompanionsSonos PostUsersSignInDataFeatures = "companions_sonos" + PostUsersSignInDataFeaturesContentFilter PostUsersSignInDataFeatures = "content_filter" PostUsersSignInDataFeaturesCustomHomeRemoval PostUsersSignInDataFeatures = "custom-home-removal" PostUsersSignInDataFeaturesDisableHomeUserFriendships PostUsersSignInDataFeatures = "disable_home_user_friendships" PostUsersSignInDataFeaturesDisableSharingFriendships PostUsersSignInDataFeatures = "disable_sharing_friendships" + PostUsersSignInDataFeaturesDownloadsGating PostUsersSignInDataFeatures = "downloads-gating" PostUsersSignInDataFeaturesDrmSupport PostUsersSignInDataFeatures = "drm_support" + PostUsersSignInDataFeaturesDvr PostUsersSignInDataFeatures = "dvr" + PostUsersSignInDataFeaturesDvrBlockUnsupportedCountries PostUsersSignInDataFeatures = "dvr-block-unsupported-countries" + PostUsersSignInDataFeaturesEpgRecentChannels PostUsersSignInDataFeatures = "epg-recent-channels" PostUsersSignInDataFeaturesExcludeRestrictions PostUsersSignInDataFeatures = "exclude restrictions" PostUsersSignInDataFeaturesFederatedAuth PostUsersSignInDataFeatures = "federated-auth" PostUsersSignInDataFeaturesFriendRequestPushNotifications PostUsersSignInDataFeatures = "friend_request_push_notifications" + PostUsersSignInDataFeaturesGrandfatherSync PostUsersSignInDataFeatures = "grandfather-sync" PostUsersSignInDataFeaturesGuidedUpgrade PostUsersSignInDataFeatures = "guided-upgrade" + PostUsersSignInDataFeaturesHardwareTranscoding PostUsersSignInDataFeatures = "hardware_transcoding" PostUsersSignInDataFeaturesHome PostUsersSignInDataFeatures = "home" + PostUsersSignInDataFeaturesHwtranscode PostUsersSignInDataFeatures = "hwtranscode" + PostUsersSignInDataFeaturesImaggaV2 PostUsersSignInDataFeatures = "imagga-v2" PostUsersSignInDataFeaturesIncreasePasswordComplexity PostUsersSignInDataFeatures = "increase-password-complexity" PostUsersSignInDataFeaturesIos14PrivacyBanner PostUsersSignInDataFeatures = "ios14-privacy-banner" PostUsersSignInDataFeaturesIterableNotificationTokens PostUsersSignInDataFeatures = "iterable-notification-tokens" + PostUsersSignInDataFeaturesItemClusters PostUsersSignInDataFeatures = "item_clusters" PostUsersSignInDataFeaturesKeepPaymentMethod PostUsersSignInDataFeatures = "keep-payment-method" PostUsersSignInDataFeaturesKevinBacon PostUsersSignInDataFeatures = "kevin-bacon" PostUsersSignInDataFeaturesKoreaConsent PostUsersSignInDataFeatures = "korea-consent" @@ -516,162 +525,54 @@ const ( PostUsersSignInDataFeaturesLightningDvrPivot PostUsersSignInDataFeatures = "lightning-dvr-pivot" PostUsersSignInDataFeaturesLiveTvSupportIncompleteSegments PostUsersSignInDataFeatures = "live-tv-support-incomplete-segments" PostUsersSignInDataFeaturesLivetv PostUsersSignInDataFeatures = "livetv" + PostUsersSignInDataFeaturesLyrics PostUsersSignInDataFeatures = "lyrics" PostUsersSignInDataFeaturesMetadataSearch PostUsersSignInDataFeatures = "metadata_search" + PostUsersSignInDataFeaturesMusicAnalysis PostUsersSignInDataFeatures = "music-analysis" + PostUsersSignInDataFeaturesMusicVideos PostUsersSignInDataFeatures = "music_videos" PostUsersSignInDataFeaturesNewPlexPassPrices PostUsersSignInDataFeatures = "new_plex_pass_prices" PostUsersSignInDataFeaturesNewsProviderSunsetModal PostUsersSignInDataFeatures = "news-provider-sunset-modal" + PostUsersSignInDataFeaturesNominatim PostUsersSignInDataFeatures = "nominatim" + PostUsersSignInDataFeaturesPass PostUsersSignInDataFeatures = "pass" PostUsersSignInDataFeaturesPhotosFavorites PostUsersSignInDataFeatures = "photos-favorites" PostUsersSignInDataFeaturesPhotosMetadataEdition PostUsersSignInDataFeatures = "photos-metadata-edition" + PostUsersSignInDataFeaturesPhotosV6Edit PostUsersSignInDataFeatures = "photosV6-edit" + PostUsersSignInDataFeaturesPhotosV6TvAlbums PostUsersSignInDataFeatures = "photosV6-tv-albums" PostUsersSignInDataFeaturesPmsHealth PostUsersSignInDataFeatures = "pms_health" + PostUsersSignInDataFeaturesPremiumDashboard PostUsersSignInDataFeatures = "premium-dashboard" + PostUsersSignInDataFeaturesPremiumMusicMetadata PostUsersSignInDataFeatures = "premium_music_metadata" PostUsersSignInDataFeaturesRadio PostUsersSignInDataFeatures = "radio" PostUsersSignInDataFeaturesRateLimitClientToken PostUsersSignInDataFeatures = "rate-limit-client-token" PostUsersSignInDataFeaturesScrobblingServicePlexTv PostUsersSignInDataFeatures = "scrobbling-service-plex-tv" + PostUsersSignInDataFeaturesSessionBandwidthRestrictions PostUsersSignInDataFeatures = "session_bandwidth_restrictions" + PostUsersSignInDataFeaturesSessionKick PostUsersSignInDataFeatures = "session_kick" PostUsersSignInDataFeaturesSharedServerNotification PostUsersSignInDataFeatures = "shared_server_notification" PostUsersSignInDataFeaturesSharedSourceNotification PostUsersSignInDataFeatures = "shared_source_notification" + PostUsersSignInDataFeaturesSigninNotification PostUsersSignInDataFeatures = "signin_notification" PostUsersSignInDataFeaturesSigninWithApple PostUsersSignInDataFeatures = "signin_with_apple" + PostUsersSignInDataFeaturesSilenceRemoval PostUsersSignInDataFeatures = "silence-removal" + PostUsersSignInDataFeaturesSleepTimer PostUsersSignInDataFeatures = "sleep-timer" PostUsersSignInDataFeaturesSpringServeAdProvider PostUsersSignInDataFeatures = "spring_serve_ad_provider" + PostUsersSignInDataFeaturesSync PostUsersSignInDataFeatures = "sync" + PostUsersSignInDataFeaturesSweetFades PostUsersSignInDataFeatures = "sweet-fades" PostUsersSignInDataFeaturesTranscoderCache PostUsersSignInDataFeatures = "transcoder_cache" + PostUsersSignInDataFeaturesTrailers PostUsersSignInDataFeatures = "trailers" PostUsersSignInDataFeaturesTunerSharing PostUsersSignInDataFeatures = "tuner-sharing" PostUsersSignInDataFeaturesTwoFactorAuthentication PostUsersSignInDataFeatures = "two-factor-authentication" PostUsersSignInDataFeaturesUnsupportedtuners PostUsersSignInDataFeatures = "unsupportedtuners" PostUsersSignInDataFeaturesUpgrade3ds2 PostUsersSignInDataFeatures = "upgrade-3ds2" + PostUsersSignInDataFeaturesVisualizers PostUsersSignInDataFeatures = "visualizers" PostUsersSignInDataFeaturesVodSchema PostUsersSignInDataFeatures = "vod-schema" PostUsersSignInDataFeaturesVodCloudflare PostUsersSignInDataFeatures = "vod_cloudflare" + PostUsersSignInDataFeaturesVolumeLeveling PostUsersSignInDataFeatures = "volume-leveling" PostUsersSignInDataFeaturesWatchTogetherInvite PostUsersSignInDataFeatures = "watch-together-invite" + PostUsersSignInDataFeaturesWatchlistRss PostUsersSignInDataFeatures = "watchlist-rss" PostUsersSignInDataFeaturesWebServerDashboard PostUsersSignInDataFeatures = "web_server_dashboard" + PostUsersSignInDataFeaturesWebhooks PostUsersSignInDataFeatures = "webhooks" ) func (e PostUsersSignInDataFeatures) ToPointer() *PostUsersSignInDataFeatures { return &e } -func (e *PostUsersSignInDataFeatures) UnmarshalJSON(data []byte) error { - var v string - if err := json.Unmarshal(data, &v); err != nil { - return err - } - switch v { - case "Android - Dolby Vision": - fallthrough - case "Android - PiP": - fallthrough - case "CU Sunset": - fallthrough - case "HRK_enable_EUR": - fallthrough - case "TREBLE-show-features": - fallthrough - case "ad-countdown-timer": - fallthrough - case "adaptive_bitrate": - fallthrough - case "amazon-loop-debug": - fallthrough - case "avod-ad-analysis": - fallthrough - case "avod-new-media": - fallthrough - case "blacklist_get_signin": - fallthrough - case "client-radio-stations": - fallthrough - case "cloudflare-turnstile-required": - fallthrough - case "collections": - fallthrough - case "comments_and_replies_push_notifications": - fallthrough - case "community_access_plex_tv": - fallthrough - case "companions_sonos": - fallthrough - case "custom-home-removal": - fallthrough - case "disable_home_user_friendships": - fallthrough - case "disable_sharing_friendships": - fallthrough - case "drm_support": - fallthrough - case "exclude restrictions": - fallthrough - case "federated-auth": - fallthrough - case "friend_request_push_notifications": - fallthrough - case "guided-upgrade": - fallthrough - case "home": - fallthrough - case "increase-password-complexity": - fallthrough - case "ios14-privacy-banner": - fallthrough - case "iterable-notification-tokens": - fallthrough - case "keep-payment-method": - fallthrough - case "kevin-bacon": - fallthrough - case "korea-consent": - fallthrough - case "le_isrg_root_x1": - fallthrough - case "lets_encrypt": - fallthrough - case "lightning-dvr-pivot": - fallthrough - case "live-tv-support-incomplete-segments": - fallthrough - case "livetv": - fallthrough - case "metadata_search": - fallthrough - case "new_plex_pass_prices": - fallthrough - case "news-provider-sunset-modal": - fallthrough - case "photos-favorites": - fallthrough - case "photos-metadata-edition": - fallthrough - case "pms_health": - fallthrough - case "radio": - fallthrough - case "rate-limit-client-token": - fallthrough - case "scrobbling-service-plex-tv": - fallthrough - case "shared_server_notification": - fallthrough - case "shared_source_notification": - fallthrough - case "signin_with_apple": - fallthrough - case "spring_serve_ad_provider": - fallthrough - case "transcoder_cache": - fallthrough - case "tuner-sharing": - fallthrough - case "two-factor-authentication": - fallthrough - case "unsupportedtuners": - fallthrough - case "upgrade-3ds2": - fallthrough - case "vod-schema": - fallthrough - case "vod_cloudflare": - fallthrough - case "watch-together-invite": - fallthrough - case "web_server_dashboard": - *e = PostUsersSignInDataFeatures(v) - return nil - default: - return fmt.Errorf("invalid value for PostUsersSignInDataFeatures: %v", v) - } -} // PostUsersSignInDataAuthenticationStatus - String representation of subscriptionActive type PostUsersSignInDataAuthenticationStatus string @@ -768,28 +669,43 @@ const ( PostUsersSignInDataAuthenticationFeaturesTrebleShowFeatures PostUsersSignInDataAuthenticationFeatures = "TREBLE-show-features" PostUsersSignInDataAuthenticationFeaturesAdCountdownTimer PostUsersSignInDataAuthenticationFeatures = "ad-countdown-timer" PostUsersSignInDataAuthenticationFeaturesAdaptiveBitrate PostUsersSignInDataAuthenticationFeatures = "adaptive_bitrate" + PostUsersSignInDataAuthenticationFeaturesAlbumTypes PostUsersSignInDataAuthenticationFeatures = "album-types" + PostUsersSignInDataAuthenticationFeaturesAllowDvr PostUsersSignInDataAuthenticationFeatures = "allow_dvr" PostUsersSignInDataAuthenticationFeaturesAmazonLoopDebug PostUsersSignInDataAuthenticationFeatures = "amazon-loop-debug" PostUsersSignInDataAuthenticationFeaturesAvodAdAnalysis PostUsersSignInDataAuthenticationFeatures = "avod-ad-analysis" PostUsersSignInDataAuthenticationFeaturesAvodNewMedia PostUsersSignInDataAuthenticationFeatures = "avod-new-media" PostUsersSignInDataAuthenticationFeaturesBlacklistGetSignin PostUsersSignInDataAuthenticationFeatures = "blacklist_get_signin" + PostUsersSignInDataAuthenticationFeaturesBoostVoices PostUsersSignInDataAuthenticationFeatures = "boost-voices" + PostUsersSignInDataAuthenticationFeaturesCameraUpload PostUsersSignInDataAuthenticationFeatures = "camera_upload" PostUsersSignInDataAuthenticationFeaturesClientRadioStations PostUsersSignInDataAuthenticationFeatures = "client-radio-stations" PostUsersSignInDataAuthenticationFeaturesCloudflareTurnstileRequired PostUsersSignInDataAuthenticationFeatures = "cloudflare-turnstile-required" + PostUsersSignInDataAuthenticationFeaturesCloudsync PostUsersSignInDataAuthenticationFeatures = "cloudsync" PostUsersSignInDataAuthenticationFeaturesCollections PostUsersSignInDataAuthenticationFeatures = "collections" PostUsersSignInDataAuthenticationFeaturesCommentsAndRepliesPushNotifications PostUsersSignInDataAuthenticationFeatures = "comments_and_replies_push_notifications" PostUsersSignInDataAuthenticationFeaturesCommunityAccessPlexTv PostUsersSignInDataAuthenticationFeatures = "community_access_plex_tv" PostUsersSignInDataAuthenticationFeaturesCompanionsSonos PostUsersSignInDataAuthenticationFeatures = "companions_sonos" + PostUsersSignInDataAuthenticationFeaturesContentFilter PostUsersSignInDataAuthenticationFeatures = "content_filter" PostUsersSignInDataAuthenticationFeaturesCustomHomeRemoval PostUsersSignInDataAuthenticationFeatures = "custom-home-removal" PostUsersSignInDataAuthenticationFeaturesDisableHomeUserFriendships PostUsersSignInDataAuthenticationFeatures = "disable_home_user_friendships" PostUsersSignInDataAuthenticationFeaturesDisableSharingFriendships PostUsersSignInDataAuthenticationFeatures = "disable_sharing_friendships" + PostUsersSignInDataAuthenticationFeaturesDownloadsGating PostUsersSignInDataAuthenticationFeatures = "downloads-gating" PostUsersSignInDataAuthenticationFeaturesDrmSupport PostUsersSignInDataAuthenticationFeatures = "drm_support" + PostUsersSignInDataAuthenticationFeaturesDvr PostUsersSignInDataAuthenticationFeatures = "dvr" + PostUsersSignInDataAuthenticationFeaturesDvrBlockUnsupportedCountries PostUsersSignInDataAuthenticationFeatures = "dvr-block-unsupported-countries" + PostUsersSignInDataAuthenticationFeaturesEpgRecentChannels PostUsersSignInDataAuthenticationFeatures = "epg-recent-channels" PostUsersSignInDataAuthenticationFeaturesExcludeRestrictions PostUsersSignInDataAuthenticationFeatures = "exclude restrictions" PostUsersSignInDataAuthenticationFeaturesFederatedAuth PostUsersSignInDataAuthenticationFeatures = "federated-auth" PostUsersSignInDataAuthenticationFeaturesFriendRequestPushNotifications PostUsersSignInDataAuthenticationFeatures = "friend_request_push_notifications" + PostUsersSignInDataAuthenticationFeaturesGrandfatherSync PostUsersSignInDataAuthenticationFeatures = "grandfather-sync" PostUsersSignInDataAuthenticationFeaturesGuidedUpgrade PostUsersSignInDataAuthenticationFeatures = "guided-upgrade" + PostUsersSignInDataAuthenticationFeaturesHardwareTranscoding PostUsersSignInDataAuthenticationFeatures = "hardware_transcoding" PostUsersSignInDataAuthenticationFeaturesHome PostUsersSignInDataAuthenticationFeatures = "home" + PostUsersSignInDataAuthenticationFeaturesHwtranscode PostUsersSignInDataAuthenticationFeatures = "hwtranscode" + PostUsersSignInDataAuthenticationFeaturesImaggaV2 PostUsersSignInDataAuthenticationFeatures = "imagga-v2" PostUsersSignInDataAuthenticationFeaturesIncreasePasswordComplexity PostUsersSignInDataAuthenticationFeatures = "increase-password-complexity" PostUsersSignInDataAuthenticationFeaturesIos14PrivacyBanner PostUsersSignInDataAuthenticationFeatures = "ios14-privacy-banner" PostUsersSignInDataAuthenticationFeaturesIterableNotificationTokens PostUsersSignInDataAuthenticationFeatures = "iterable-notification-tokens" + PostUsersSignInDataAuthenticationFeaturesItemClusters PostUsersSignInDataAuthenticationFeatures = "item_clusters" PostUsersSignInDataAuthenticationFeaturesKeepPaymentMethod PostUsersSignInDataAuthenticationFeatures = "keep-payment-method" PostUsersSignInDataAuthenticationFeaturesKevinBacon PostUsersSignInDataAuthenticationFeatures = "kevin-bacon" PostUsersSignInDataAuthenticationFeaturesKoreaConsent PostUsersSignInDataAuthenticationFeatures = "korea-consent" @@ -798,162 +714,54 @@ const ( PostUsersSignInDataAuthenticationFeaturesLightningDvrPivot PostUsersSignInDataAuthenticationFeatures = "lightning-dvr-pivot" PostUsersSignInDataAuthenticationFeaturesLiveTvSupportIncompleteSegments PostUsersSignInDataAuthenticationFeatures = "live-tv-support-incomplete-segments" PostUsersSignInDataAuthenticationFeaturesLivetv PostUsersSignInDataAuthenticationFeatures = "livetv" + PostUsersSignInDataAuthenticationFeaturesLyrics PostUsersSignInDataAuthenticationFeatures = "lyrics" PostUsersSignInDataAuthenticationFeaturesMetadataSearch PostUsersSignInDataAuthenticationFeatures = "metadata_search" + PostUsersSignInDataAuthenticationFeaturesMusicAnalysis PostUsersSignInDataAuthenticationFeatures = "music-analysis" + PostUsersSignInDataAuthenticationFeaturesMusicVideos PostUsersSignInDataAuthenticationFeatures = "music_videos" PostUsersSignInDataAuthenticationFeaturesNewPlexPassPrices PostUsersSignInDataAuthenticationFeatures = "new_plex_pass_prices" PostUsersSignInDataAuthenticationFeaturesNewsProviderSunsetModal PostUsersSignInDataAuthenticationFeatures = "news-provider-sunset-modal" + PostUsersSignInDataAuthenticationFeaturesNominatim PostUsersSignInDataAuthenticationFeatures = "nominatim" + PostUsersSignInDataAuthenticationFeaturesPass PostUsersSignInDataAuthenticationFeatures = "pass" PostUsersSignInDataAuthenticationFeaturesPhotosFavorites PostUsersSignInDataAuthenticationFeatures = "photos-favorites" PostUsersSignInDataAuthenticationFeaturesPhotosMetadataEdition PostUsersSignInDataAuthenticationFeatures = "photos-metadata-edition" + PostUsersSignInDataAuthenticationFeaturesPhotosV6Edit PostUsersSignInDataAuthenticationFeatures = "photosV6-edit" + PostUsersSignInDataAuthenticationFeaturesPhotosV6TvAlbums PostUsersSignInDataAuthenticationFeatures = "photosV6-tv-albums" PostUsersSignInDataAuthenticationFeaturesPmsHealth PostUsersSignInDataAuthenticationFeatures = "pms_health" + PostUsersSignInDataAuthenticationFeaturesPremiumDashboard PostUsersSignInDataAuthenticationFeatures = "premium-dashboard" + PostUsersSignInDataAuthenticationFeaturesPremiumMusicMetadata PostUsersSignInDataAuthenticationFeatures = "premium_music_metadata" PostUsersSignInDataAuthenticationFeaturesRadio PostUsersSignInDataAuthenticationFeatures = "radio" PostUsersSignInDataAuthenticationFeaturesRateLimitClientToken PostUsersSignInDataAuthenticationFeatures = "rate-limit-client-token" PostUsersSignInDataAuthenticationFeaturesScrobblingServicePlexTv PostUsersSignInDataAuthenticationFeatures = "scrobbling-service-plex-tv" + PostUsersSignInDataAuthenticationFeaturesSessionBandwidthRestrictions PostUsersSignInDataAuthenticationFeatures = "session_bandwidth_restrictions" + PostUsersSignInDataAuthenticationFeaturesSessionKick PostUsersSignInDataAuthenticationFeatures = "session_kick" PostUsersSignInDataAuthenticationFeaturesSharedServerNotification PostUsersSignInDataAuthenticationFeatures = "shared_server_notification" PostUsersSignInDataAuthenticationFeaturesSharedSourceNotification PostUsersSignInDataAuthenticationFeatures = "shared_source_notification" + PostUsersSignInDataAuthenticationFeaturesSigninNotification PostUsersSignInDataAuthenticationFeatures = "signin_notification" PostUsersSignInDataAuthenticationFeaturesSigninWithApple PostUsersSignInDataAuthenticationFeatures = "signin_with_apple" + PostUsersSignInDataAuthenticationFeaturesSilenceRemoval PostUsersSignInDataAuthenticationFeatures = "silence-removal" + PostUsersSignInDataAuthenticationFeaturesSleepTimer PostUsersSignInDataAuthenticationFeatures = "sleep-timer" PostUsersSignInDataAuthenticationFeaturesSpringServeAdProvider PostUsersSignInDataAuthenticationFeatures = "spring_serve_ad_provider" + PostUsersSignInDataAuthenticationFeaturesSync PostUsersSignInDataAuthenticationFeatures = "sync" + PostUsersSignInDataAuthenticationFeaturesSweetFades PostUsersSignInDataAuthenticationFeatures = "sweet-fades" PostUsersSignInDataAuthenticationFeaturesTranscoderCache PostUsersSignInDataAuthenticationFeatures = "transcoder_cache" + PostUsersSignInDataAuthenticationFeaturesTrailers PostUsersSignInDataAuthenticationFeatures = "trailers" PostUsersSignInDataAuthenticationFeaturesTunerSharing PostUsersSignInDataAuthenticationFeatures = "tuner-sharing" PostUsersSignInDataAuthenticationFeaturesTwoFactorAuthentication PostUsersSignInDataAuthenticationFeatures = "two-factor-authentication" PostUsersSignInDataAuthenticationFeaturesUnsupportedtuners PostUsersSignInDataAuthenticationFeatures = "unsupportedtuners" PostUsersSignInDataAuthenticationFeaturesUpgrade3ds2 PostUsersSignInDataAuthenticationFeatures = "upgrade-3ds2" + PostUsersSignInDataAuthenticationFeaturesVisualizers PostUsersSignInDataAuthenticationFeatures = "visualizers" PostUsersSignInDataAuthenticationFeaturesVodSchema PostUsersSignInDataAuthenticationFeatures = "vod-schema" PostUsersSignInDataAuthenticationFeaturesVodCloudflare PostUsersSignInDataAuthenticationFeatures = "vod_cloudflare" + PostUsersSignInDataAuthenticationFeaturesVolumeLeveling PostUsersSignInDataAuthenticationFeatures = "volume-leveling" PostUsersSignInDataAuthenticationFeaturesWatchTogetherInvite PostUsersSignInDataAuthenticationFeatures = "watch-together-invite" + PostUsersSignInDataAuthenticationFeaturesWatchlistRss PostUsersSignInDataAuthenticationFeatures = "watchlist-rss" PostUsersSignInDataAuthenticationFeaturesWebServerDashboard PostUsersSignInDataAuthenticationFeatures = "web_server_dashboard" + PostUsersSignInDataAuthenticationFeaturesWebhooks PostUsersSignInDataAuthenticationFeatures = "webhooks" ) func (e PostUsersSignInDataAuthenticationFeatures) ToPointer() *PostUsersSignInDataAuthenticationFeatures { return &e } -func (e *PostUsersSignInDataAuthenticationFeatures) UnmarshalJSON(data []byte) error { - var v string - if err := json.Unmarshal(data, &v); err != nil { - return err - } - switch v { - case "Android - Dolby Vision": - fallthrough - case "Android - PiP": - fallthrough - case "CU Sunset": - fallthrough - case "HRK_enable_EUR": - fallthrough - case "TREBLE-show-features": - fallthrough - case "ad-countdown-timer": - fallthrough - case "adaptive_bitrate": - fallthrough - case "amazon-loop-debug": - fallthrough - case "avod-ad-analysis": - fallthrough - case "avod-new-media": - fallthrough - case "blacklist_get_signin": - fallthrough - case "client-radio-stations": - fallthrough - case "cloudflare-turnstile-required": - fallthrough - case "collections": - fallthrough - case "comments_and_replies_push_notifications": - fallthrough - case "community_access_plex_tv": - fallthrough - case "companions_sonos": - fallthrough - case "custom-home-removal": - fallthrough - case "disable_home_user_friendships": - fallthrough - case "disable_sharing_friendships": - fallthrough - case "drm_support": - fallthrough - case "exclude restrictions": - fallthrough - case "federated-auth": - fallthrough - case "friend_request_push_notifications": - fallthrough - case "guided-upgrade": - fallthrough - case "home": - fallthrough - case "increase-password-complexity": - fallthrough - case "ios14-privacy-banner": - fallthrough - case "iterable-notification-tokens": - fallthrough - case "keep-payment-method": - fallthrough - case "kevin-bacon": - fallthrough - case "korea-consent": - fallthrough - case "le_isrg_root_x1": - fallthrough - case "lets_encrypt": - fallthrough - case "lightning-dvr-pivot": - fallthrough - case "live-tv-support-incomplete-segments": - fallthrough - case "livetv": - fallthrough - case "metadata_search": - fallthrough - case "new_plex_pass_prices": - fallthrough - case "news-provider-sunset-modal": - fallthrough - case "photos-favorites": - fallthrough - case "photos-metadata-edition": - fallthrough - case "pms_health": - fallthrough - case "radio": - fallthrough - case "rate-limit-client-token": - fallthrough - case "scrobbling-service-plex-tv": - fallthrough - case "shared_server_notification": - fallthrough - case "shared_source_notification": - fallthrough - case "signin_with_apple": - fallthrough - case "spring_serve_ad_provider": - fallthrough - case "transcoder_cache": - fallthrough - case "tuner-sharing": - fallthrough - case "two-factor-authentication": - fallthrough - case "unsupportedtuners": - fallthrough - case "upgrade-3ds2": - fallthrough - case "vod-schema": - fallthrough - case "vod_cloudflare": - fallthrough - case "watch-together-invite": - fallthrough - case "web_server_dashboard": - *e = PostUsersSignInDataAuthenticationFeatures(v) - return nil - default: - return fmt.Errorf("invalid value for PostUsersSignInDataAuthenticationFeatures: %v", v) - } -} // PostUsersSignInDataAuthenticationResponseStatus - String representation of subscriptionActive type PostUsersSignInDataAuthenticationResponseStatus string @@ -1267,7 +1075,7 @@ type PostUsersSignInDataUserPlexAccount struct { Locale *string `json:"locale"` // If you are subscribed to the Plex newsletter MailingListActive *bool `default:"false" json:"mailingListActive"` - // Your current mailing list status + // Your current mailing list status (active or unsubscribed) MailingListStatus PostUsersSignInDataMailingListStatus `json:"mailingListStatus"` // The maximum number of accounts allowed in the Plex Home MaxHomeSize int `json:"maxHomeSize"` diff --git a/plex.go b/plex.go index 6fc4087..6119daa 100644 --- a/plex.go +++ b/plex.go @@ -1008,7 +1008,7 @@ func (s *Plex) GetHomeData(ctx context.Context, opts ...operations.Option) (*ope // GetServerResources - Get Server Resources // Get Plex server access tokens and server connections -func (s *Plex) GetServerResources(ctx context.Context, includeHTTPS *operations.IncludeHTTPS, includeRelay *operations.IncludeRelay, includeIPv6 *operations.IncludeIPv6, opts ...operations.Option) (*operations.GetServerResourcesResponse, error) { +func (s *Plex) GetServerResources(ctx context.Context, includeHTTPS *operations.IncludeHTTPS, includeRelay *operations.IncludeRelay, includeIPv6 *operations.IncludeIPv6, clientID *string, opts ...operations.Option) (*operations.GetServerResourcesResponse, error) { hookCtx := hooks.HookContext{ Context: ctx, OperationID: "get-server-resources", @@ -1020,6 +1020,11 @@ func (s *Plex) GetServerResources(ctx context.Context, includeHTTPS *operations. IncludeHTTPS: includeHTTPS, IncludeRelay: includeRelay, IncludeIPv6: includeIPv6, + ClientID: clientID, + } + + globals := operations.GetServerResourcesGlobals{ + ClientID: s.sdkConfiguration.Globals.ClientID, } o := operations.Options{} @@ -1063,7 +1068,7 @@ func (s *Plex) GetServerResources(ctx context.Context, includeHTTPS *operations. req.Header.Set("Accept", "application/json") req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent) - if err := utils.PopulateQueryParams(ctx, req, request, nil); err != nil { + if err := utils.PopulateQueryParams(ctx, req, request, globals); err != nil { return nil, fmt.Errorf("error populating query params: %w", err) } @@ -1497,7 +1502,7 @@ func (s *Plex) GetPin(ctx context.Context, request operations.GetPinRequest, opt // GetTokenByPinID - Get Access Token by PinId // Retrieve an Access Token from Plex.tv after the Pin has been authenticated -func (s *Plex) GetTokenByPinID(ctx context.Context, pinID int64, opts ...operations.Option) (*operations.GetTokenByPinIDResponse, error) { +func (s *Plex) GetTokenByPinID(ctx context.Context, request operations.GetTokenByPinIDRequest, opts ...operations.Option) (*operations.GetTokenByPinIDResponse, error) { hookCtx := hooks.HookContext{ Context: ctx, OperationID: "getTokenByPinId", @@ -1505,8 +1510,12 @@ func (s *Plex) GetTokenByPinID(ctx context.Context, pinID int64, opts ...operati SecuritySource: nil, } - request := operations.GetTokenByPinIDRequest{ - PinID: pinID, + globals := operations.GetTokenByPinIDGlobals{ + ClientID: s.sdkConfiguration.Globals.ClientID, + ClientName: s.sdkConfiguration.Globals.ClientName, + DeviceName: s.sdkConfiguration.Globals.DeviceName, + ClientVersion: s.sdkConfiguration.Globals.ClientVersion, + ClientPlatform: s.sdkConfiguration.Globals.ClientPlatform, } o := operations.Options{} @@ -1527,7 +1536,7 @@ func (s *Plex) GetTokenByPinID(ctx context.Context, pinID int64, opts ...operati baseURL = *o.ServerURL } - opURL, err := utils.GenerateURL(ctx, baseURL, "/pins/{pinID}", request, nil) + opURL, err := utils.GenerateURL(ctx, baseURL, "/pins/{pinID}", request, globals) if err != nil { return nil, fmt.Errorf("error generating URL: %w", err) } @@ -1550,6 +1559,10 @@ func (s *Plex) GetTokenByPinID(ctx context.Context, pinID int64, opts ...operati req.Header.Set("Accept", "application/json") req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent) + if err := utils.PopulateQueryParams(ctx, req, request, globals); err != nil { + return nil, fmt.Errorf("error populating query params: %w", err) + } + globalRetryConfig := s.sdkConfiguration.RetryConfig retryConfig := o.Retries if retryConfig == nil { diff --git a/plexapi.go b/plexapi.go index 918cfb6..b0ebcee 100644 --- a/plexapi.go +++ b/plexapi.go @@ -73,6 +73,30 @@ func (c *sdkConfiguration) GetServerDetails() (string, map[string]string) { } // PlexAPI - 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) | - type PlexAPI struct { // Operations against the Plex Media Server System. // @@ -311,9 +335,9 @@ func New(opts ...SDKOption) *PlexAPI { sdkConfiguration: sdkConfiguration{ Language: "go", OpenAPIDocVersion: "0.0.3", - SDKVersion: "0.13.0", - GenVersion: "2.422.22", - UserAgent: "speakeasy-sdk/go 0.13.0 2.422.22 0.0.3 github.com/LukeHagar/plexgo", + SDKVersion: "0.14.0", + GenVersion: "2.428.1", + UserAgent: "speakeasy-sdk/go 0.14.0 2.428.1 0.0.3 github.com/LukeHagar/plexgo", Globals: globals.Globals{}, ServerDefaults: []map[string]string{ {