mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 20:47:49 +00:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
81c55cb08b | ||
|
|
860991f2a0 | ||
|
|
d25639db53 | ||
|
|
227e2351d5 | ||
|
|
3bd4f51297 | ||
|
|
4828de2345 | ||
|
|
2beb707ed5 | ||
|
|
affe5d5a8c | ||
|
|
d16abdad70 |
1
.github/workflows/sdk_generation.yaml
vendored
1
.github/workflows/sdk_generation.yaml
vendored
@@ -24,6 +24,7 @@ jobs:
|
||||
mode: direct
|
||||
set_version: ${{ github.event.inputs.set_version }}
|
||||
speakeasy_version: latest
|
||||
dotnet_version: "8.x"
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
nuget_api_key: ${{ secrets.NUGET_API_KEY }}
|
||||
|
||||
1
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/.name
generated
Normal file
1
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/.name
generated
Normal file
@@ -0,0 +1 @@
|
||||
LukeHagar.PlexAPI.SDK
|
||||
4
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/encodings.xml
generated
Normal file
4
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/encodings.xml
generated
Normal file
@@ -0,0 +1,4 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="Encoding" addBOMForNewFiles="with BOM under Windows, with no BOM otherwise" />
|
||||
</project>
|
||||
8
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/indexLayout.xml
generated
Normal file
8
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/indexLayout.xml
generated
Normal file
@@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="UserContentModel">
|
||||
<attachedFolders />
|
||||
<explicitIncludes />
|
||||
<explicitExcludes />
|
||||
</component>
|
||||
</project>
|
||||
6
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/projectSettingsUpdater.xml
generated
Normal file
6
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/projectSettingsUpdater.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="RiderProjectSettingsUpdater">
|
||||
<option name="vcsConfiguration" value="3" />
|
||||
</component>
|
||||
</project>
|
||||
6
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/vcs.xml
generated
Normal file
6
.idea/.idea.LukeHagar.PlexAPI.SDK/.idea/vcs.xml
generated
Normal file
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: 5a8dbcbc-e0ee-41f0-9d84-b8b50567d1e9
|
||||
management:
|
||||
docChecksum: 4b984f7caf05a57f71aaaaa33a3a51da
|
||||
docChecksum: afed3802b7464cc21bb376d0f1d86fed
|
||||
docVersion: 0.0.3
|
||||
speakeasyVersion: 1.402.14
|
||||
generationVersion: 2.422.22
|
||||
releaseVersion: 0.8.0
|
||||
configChecksum: b2f977640ef890e79b91e89ca8b0ab90
|
||||
speakeasyVersion: 1.405.4
|
||||
generationVersion: 2.428.1
|
||||
releaseVersion: 0.8.6
|
||||
configChecksum: dfd4d6b56ab7562ddadf9bb6b093c61f
|
||||
repoURL: https://github.com/LukeHagar/plexcsharp.git
|
||||
repoSubDirectory: .
|
||||
published: true
|
||||
@@ -14,10 +14,10 @@ features:
|
||||
csharp:
|
||||
additionalDependencies: 0.1.0
|
||||
constsAndDefaults: 0.0.1
|
||||
core: 3.10.1
|
||||
core: 3.10.3
|
||||
deprecations: 2.81.2
|
||||
enums: 2.82.0
|
||||
errors: 0.0.2
|
||||
errors: 0.0.3
|
||||
flattening: 2.81.3
|
||||
globalSecurity: 2.83.6
|
||||
globalSecurityCallbacks: 0.1.0
|
||||
@@ -738,6 +738,7 @@ generatedFiles:
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataFeatures.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataMailingListStatus.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataMediaReviewsVisibility.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataRequest.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataRequestBody.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataResponse.cs
|
||||
- LukeHagar/PlexAPI/SDK/Models/Requests/PostUsersSignInDataServices.cs
|
||||
@@ -1528,6 +1529,7 @@ generatedFiles:
|
||||
- docs/Models/Requests/PostUsersSignInDataFeatures.md
|
||||
- docs/Models/Requests/PostUsersSignInDataMailingListStatus.md
|
||||
- docs/Models/Requests/PostUsersSignInDataMediaReviewsVisibility.md
|
||||
- docs/Models/Requests/PostUsersSignInDataRequest.md
|
||||
- docs/Models/Requests/PostUsersSignInDataRequestBody.md
|
||||
- docs/Models/Requests/PostUsersSignInDataResponse.md
|
||||
- docs/Models/Requests/PostUsersSignInDataServices.md
|
||||
@@ -1920,6 +1922,7 @@ examples:
|
||||
includeHttps: 1
|
||||
includeRelay: 1
|
||||
includeIPv6: 1
|
||||
X-Plex-Client-Identifier: "gcgzw5rz2xovp84b4vha3a40"
|
||||
responses:
|
||||
"401":
|
||||
application/json: {"errors": []}
|
||||
@@ -1935,6 +1938,7 @@ examples:
|
||||
X-Plex-Device: "Linux"
|
||||
X-Plex-Version: "4.133.0"
|
||||
X-Plex-Platform: "Chrome"
|
||||
X-Plex-Client-Identifier: "gcgzw5rz2xovp84b4vha3a40"
|
||||
responses:
|
||||
"200":
|
||||
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
|
||||
@@ -1947,7 +1951,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:
|
||||
"200":
|
||||
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
|
||||
@@ -2398,6 +2407,23 @@ examples:
|
||||
application/json: {"errors": []}
|
||||
"400":
|
||||
application/json: {"errors": []}
|
||||
"":
|
||||
parameters:
|
||||
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"
|
||||
requestBody:
|
||||
application/x-www-form-urlencoded: {"login": "username@email.com", "password": "password123", "verificationCode": "123456"}
|
||||
responses:
|
||||
"201":
|
||||
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": 1721154902, "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": 1722364046, "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, "pastSubscriptions": [{"id": "string", "mode": "string", "renewsAt": "string", "endsAt": "1556281940", "canceled": "0", "gracePeriod": "0", "onHold": "0", "canReactivate": "0", "canUpgrade": "0", "canDowngrade": "0", "canConvert": "0", "type": "plexpass", "transfer": "string", "state": "ended", "billing": {"paymentMethodId": 481656}}], "trials": [{}]}
|
||||
"400":
|
||||
application/json: {"errors": [{"code": 1000, "message": "X-Plex-Client-Identifier is missing", "status": 400}, {"code": 1000, "message": "X-Plex-Client-Identifier is missing", "status": 400}, {"code": 1000, "message": "X-Plex-Client-Identifier is missing", "status": 400}]}
|
||||
"401":
|
||||
application/json: {"errors": []}
|
||||
getStatistics:
|
||||
"":
|
||||
parameters:
|
||||
@@ -2574,7 +2600,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":
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
csharp:
|
||||
version: 0.8.0
|
||||
version: 0.8.6
|
||||
additionalDependencies: []
|
||||
author: LukeHagar
|
||||
clientServerStatusCodesAsErrors: true
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.402.14
|
||||
speakeasyVersion: 1.405.4
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -16,8 +16,8 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ef43acbcbd2589d257d0c898ba6d401c7afc9070b9ab1bd628af2b4db1413560
|
||||
sourceBlobDigest: sha256:801d5aa55d92b23efb9310aa60fab4fd00987069401931ce4a15ee80effb09e1
|
||||
sourceRevisionDigest: sha256:79dca9232c55c6829ffc5f89a9eeb957e6273213be222d012238da40d5086df1
|
||||
sourceBlobDigest: sha256:91b080122ff1fe0c86a02f3c39accc03dbad569b4324503941523d1d29c51b7e
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -25,10 +25,10 @@ targets:
|
||||
plexcsharp:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ef43acbcbd2589d257d0c898ba6d401c7afc9070b9ab1bd628af2b4db1413560
|
||||
sourceBlobDigest: sha256:801d5aa55d92b23efb9310aa60fab4fd00987069401931ce4a15ee80effb09e1
|
||||
sourceRevisionDigest: sha256:79dca9232c55c6829ffc5f89a9eeb957e6273213be222d012238da40d5086df1
|
||||
sourceBlobDigest: sha256:91b080122ff1fe0c86a02f3c39accc03dbad569b4324503941523d1d29c51b7e
|
||||
codeSamplesNamespace: code-samples-csharp-plexcsharp
|
||||
codeSamplesRevisionDigest: sha256:3a4987f336fc053a5de8964124876ab5be7b353bfb85c09868375c83a49de0a8
|
||||
codeSamplesRevisionDigest: sha256:987240ddee9f8c477ffda9c313d53abd6cb52b460ba53b0bed9ec62188b7f4a3
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
@@ -74,10 +74,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -69,7 +69,7 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
/// Sign in user with username and password and return user data with Plex authentication token
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
Task<PostUsersSignInDataResponse> PostUsersSignInDataAsync(PostUsersSignInDataRequestBody? request = null, string? serverUrl = null);
|
||||
Task<PostUsersSignInDataResponse> PostUsersSignInDataAsync(PostUsersSignInDataRequest? request = null, string? serverUrl = null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -85,20 +85,20 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
/// List of server URLs available for the getTokenDetails operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetTokenDetailsServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the post-users-sign-in-data operation.
|
||||
/// </summary>
|
||||
public static readonly string[] PostUsersSignInDataServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
@@ -398,21 +398,26 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse);
|
||||
}
|
||||
|
||||
public async Task<PostUsersSignInDataResponse> PostUsersSignInDataAsync(PostUsersSignInDataRequestBody? request = null, string? serverUrl = null)
|
||||
public async Task<PostUsersSignInDataResponse> PostUsersSignInDataAsync(PostUsersSignInDataRequest? request = null, string? serverUrl = null)
|
||||
{
|
||||
request.ClientID ??= SDKConfiguration.ClientID;
|
||||
request.ClientName ??= SDKConfiguration.ClientName;
|
||||
request.ClientVersion ??= SDKConfiguration.ClientVersion;
|
||||
request.ClientPlatform ??= SDKConfiguration.ClientPlatform;
|
||||
request.DeviceName ??= SDKConfiguration.DeviceName;
|
||||
|
||||
string baseUrl = Utilities.TemplateUrl(PostUsersSignInDataServerList[0], new Dictionary<string, string>(){
|
||||
});
|
||||
if (serverUrl != null)
|
||||
{
|
||||
baseUrl = serverUrl;
|
||||
}
|
||||
|
||||
var urlString = baseUrl + "/users/signin";
|
||||
var urlString = URLBuilder.Build(baseUrl, "/users/signin", request);
|
||||
|
||||
var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString);
|
||||
httpRequest.Headers.Add("user-agent", _userAgent);
|
||||
|
||||
var serializedBody = RequestBodySerializer.Serialize(request, "Request", "form", false, true);
|
||||
var serializedBody = RequestBodySerializer.Serialize(request, "RequestBody", "form", false, true);
|
||||
if (serializedBody != null)
|
||||
{
|
||||
httpRequest.Content = serializedBody;
|
||||
|
||||
@@ -101,10 +101,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -73,10 +73,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -241,10 +241,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -94,10 +94,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -3,14 +3,38 @@
|
||||
<PropertyGroup>
|
||||
<IsPackable>true</IsPackable>
|
||||
<PackageId>LukeHagar.PlexAPI.SDK</PackageId>
|
||||
<Version>0.8.0</Version>
|
||||
<Version>0.8.6</Version>
|
||||
<TargetFramework>net8.0</TargetFramework>
|
||||
<Authors>LukeHagar</Authors>
|
||||
<Copyright>Copyright (c) LukeHagar 2024</Copyright>
|
||||
<RepositoryUrl>https://github.com/LukeHagar/plexcsharp.git</RepositoryUrl>
|
||||
<RepositoryType>git</RepositoryType>
|
||||
<PackageTags>Plex Media Server SDK</PackageTags>
|
||||
<Description>Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server</Description>
|
||||
<Description># 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) | -
|
||||
</Description>
|
||||
</PropertyGroup>
|
||||
|
||||
<PropertyGroup>
|
||||
|
||||
@@ -90,10 +90,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -29,6 +29,10 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AdCountdownTimer,
|
||||
[JsonProperty("adaptive_bitrate")]
|
||||
AdaptiveBitrate,
|
||||
[JsonProperty("album-types")]
|
||||
AlbumTypes,
|
||||
[JsonProperty("allow_dvr")]
|
||||
AllowDvr,
|
||||
[JsonProperty("amazon-loop-debug")]
|
||||
AmazonLoopDebug,
|
||||
[JsonProperty("avod-ad-analysis")]
|
||||
@@ -37,10 +41,16 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AvodNewMedia,
|
||||
[JsonProperty("blacklist_get_signin")]
|
||||
BlacklistGetSignin,
|
||||
[JsonProperty("boost-voices")]
|
||||
BoostVoices,
|
||||
[JsonProperty("camera_upload")]
|
||||
CameraUpload,
|
||||
[JsonProperty("client-radio-stations")]
|
||||
ClientRadioStations,
|
||||
[JsonProperty("cloudflare-turnstile-required")]
|
||||
CloudflareTurnstileRequired,
|
||||
[JsonProperty("cloudsync")]
|
||||
Cloudsync,
|
||||
[JsonProperty("collections")]
|
||||
Collections,
|
||||
[JsonProperty("comments_and_replies_push_notifications")]
|
||||
@@ -49,30 +59,50 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
CommunityAccessPlexTv,
|
||||
[JsonProperty("companions_sonos")]
|
||||
CompanionsSonos,
|
||||
[JsonProperty("content_filter")]
|
||||
ContentFilter,
|
||||
[JsonProperty("custom-home-removal")]
|
||||
CustomHomeRemoval,
|
||||
[JsonProperty("disable_home_user_friendships")]
|
||||
DisableHomeUserFriendships,
|
||||
[JsonProperty("disable_sharing_friendships")]
|
||||
DisableSharingFriendships,
|
||||
[JsonProperty("downloads-gating")]
|
||||
DownloadsGating,
|
||||
[JsonProperty("drm_support")]
|
||||
DrmSupport,
|
||||
[JsonProperty("dvr")]
|
||||
Dvr,
|
||||
[JsonProperty("dvr-block-unsupported-countries")]
|
||||
DvrBlockUnsupportedCountries,
|
||||
[JsonProperty("epg-recent-channels")]
|
||||
EpgRecentChannels,
|
||||
[JsonProperty("exclude restrictions")]
|
||||
ExcludeRestrictions,
|
||||
[JsonProperty("federated-auth")]
|
||||
FederatedAuth,
|
||||
[JsonProperty("friend_request_push_notifications")]
|
||||
FriendRequestPushNotifications,
|
||||
[JsonProperty("grandfather-sync")]
|
||||
GrandfatherSync,
|
||||
[JsonProperty("guided-upgrade")]
|
||||
GuidedUpgrade,
|
||||
[JsonProperty("hardware_transcoding")]
|
||||
HardwareTranscoding,
|
||||
[JsonProperty("home")]
|
||||
Home,
|
||||
[JsonProperty("hwtranscode")]
|
||||
Hwtranscode,
|
||||
[JsonProperty("imagga-v2")]
|
||||
ImaggaV2,
|
||||
[JsonProperty("increase-password-complexity")]
|
||||
IncreasePasswordComplexity,
|
||||
[JsonProperty("ios14-privacy-banner")]
|
||||
Ios14PrivacyBanner,
|
||||
[JsonProperty("iterable-notification-tokens")]
|
||||
IterableNotificationTokens,
|
||||
[JsonProperty("item_clusters")]
|
||||
ItemClusters,
|
||||
[JsonProperty("keep-payment-method")]
|
||||
KeepPaymentMethod,
|
||||
[JsonProperty("kevin-bacon")]
|
||||
@@ -89,34 +119,68 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
LiveTvSupportIncompleteSegments,
|
||||
[JsonProperty("livetv")]
|
||||
Livetv,
|
||||
[JsonProperty("lyrics")]
|
||||
Lyrics,
|
||||
[JsonProperty("metadata_search")]
|
||||
MetadataSearch,
|
||||
[JsonProperty("music-analysis")]
|
||||
MusicAnalysis,
|
||||
[JsonProperty("music_videos")]
|
||||
MusicVideos,
|
||||
[JsonProperty("new_plex_pass_prices")]
|
||||
NewPlexPassPrices,
|
||||
[JsonProperty("news-provider-sunset-modal")]
|
||||
NewsProviderSunsetModal,
|
||||
[JsonProperty("nominatim")]
|
||||
Nominatim,
|
||||
[JsonProperty("pass")]
|
||||
Pass,
|
||||
[JsonProperty("photos-favorites")]
|
||||
PhotosFavorites,
|
||||
[JsonProperty("photos-metadata-edition")]
|
||||
PhotosMetadataEdition,
|
||||
[JsonProperty("photosV6-edit")]
|
||||
PhotosV6Edit,
|
||||
[JsonProperty("photosV6-tv-albums")]
|
||||
PhotosV6TvAlbums,
|
||||
[JsonProperty("pms_health")]
|
||||
PmsHealth,
|
||||
[JsonProperty("premium-dashboard")]
|
||||
PremiumDashboard,
|
||||
[JsonProperty("premium_music_metadata")]
|
||||
PremiumMusicMetadata,
|
||||
[JsonProperty("radio")]
|
||||
Radio,
|
||||
[JsonProperty("rate-limit-client-token")]
|
||||
RateLimitClientToken,
|
||||
[JsonProperty("scrobbling-service-plex-tv")]
|
||||
ScrobblingServicePlexTv,
|
||||
[JsonProperty("session_bandwidth_restrictions")]
|
||||
SessionBandwidthRestrictions,
|
||||
[JsonProperty("session_kick")]
|
||||
SessionKick,
|
||||
[JsonProperty("shared_server_notification")]
|
||||
SharedServerNotification,
|
||||
[JsonProperty("shared_source_notification")]
|
||||
SharedSourceNotification,
|
||||
[JsonProperty("signin_notification")]
|
||||
SigninNotification,
|
||||
[JsonProperty("signin_with_apple")]
|
||||
SigninWithApple,
|
||||
[JsonProperty("silence-removal")]
|
||||
SilenceRemoval,
|
||||
[JsonProperty("sleep-timer")]
|
||||
SleepTimer,
|
||||
[JsonProperty("spring_serve_ad_provider")]
|
||||
SpringServeAdProvider,
|
||||
[JsonProperty("sync")]
|
||||
Sync,
|
||||
[JsonProperty("sweet-fades")]
|
||||
SweetFades,
|
||||
[JsonProperty("transcoder_cache")]
|
||||
TranscoderCache,
|
||||
[JsonProperty("trailers")]
|
||||
Trailers,
|
||||
[JsonProperty("tuner-sharing")]
|
||||
TunerSharing,
|
||||
[JsonProperty("two-factor-authentication")]
|
||||
@@ -125,14 +189,22 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
Unsupportedtuners,
|
||||
[JsonProperty("upgrade-3ds2")]
|
||||
Upgrade3ds2,
|
||||
[JsonProperty("visualizers")]
|
||||
Visualizers,
|
||||
[JsonProperty("vod-schema")]
|
||||
VodSchema,
|
||||
[JsonProperty("vod_cloudflare")]
|
||||
VodCloudflare,
|
||||
[JsonProperty("volume-leveling")]
|
||||
VolumeLeveling,
|
||||
[JsonProperty("watch-together-invite")]
|
||||
WatchTogetherInvite,
|
||||
[JsonProperty("watchlist-rss")]
|
||||
WatchlistRss,
|
||||
[JsonProperty("web_server_dashboard")]
|
||||
WebServerDashboard,
|
||||
[JsonProperty("webhooks")]
|
||||
Webhooks,
|
||||
}
|
||||
|
||||
public static class FeaturesExtension
|
||||
|
||||
@@ -26,6 +26,18 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=strong")]
|
||||
public bool? Strong { get; set; } = false;
|
||||
|
||||
/// <summary>
|
||||
/// The unique identifier for the client application<br/>
|
||||
///
|
||||
/// <remarks>
|
||||
/// This is used to track the client application and its usage<br/>
|
||||
/// (UUID, serial number, or other number unique per device)<br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Client-Identifier")]
|
||||
public string? ClientID { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Product")]
|
||||
public string? ClientName { get; set; }
|
||||
|
||||
|
||||
@@ -37,5 +37,17 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=includeIPv6")]
|
||||
public IncludeIPv6? IncludeIPv6 { get; set; } = LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Disable;
|
||||
|
||||
/// <summary>
|
||||
/// The unique identifier for the client application<br/>
|
||||
///
|
||||
/// <remarks>
|
||||
/// This is used to track the client application and its usage<br/>
|
||||
/// (UUID, serial number, or other number unique per device)<br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Client-Identifier")]
|
||||
public string? ClientID { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -19,5 +19,29 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("pathParam:style=simple,explode=false,name=pinID")]
|
||||
public long PinID { get; set; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// The unique identifier for the client application<br/>
|
||||
///
|
||||
/// <remarks>
|
||||
/// This is used to track the client application and its usage<br/>
|
||||
/// (UUID, serial number, or other number unique per device)<br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Client-Identifier")]
|
||||
public string? ClientID { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Product")]
|
||||
public string? ClientName { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Device")]
|
||||
public string? DeviceName { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Version")]
|
||||
public string? ClientVersion { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Platform")]
|
||||
public string? ClientPlatform { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -29,6 +29,10 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AdCountdownTimer,
|
||||
[JsonProperty("adaptive_bitrate")]
|
||||
AdaptiveBitrate,
|
||||
[JsonProperty("album-types")]
|
||||
AlbumTypes,
|
||||
[JsonProperty("allow_dvr")]
|
||||
AllowDvr,
|
||||
[JsonProperty("amazon-loop-debug")]
|
||||
AmazonLoopDebug,
|
||||
[JsonProperty("avod-ad-analysis")]
|
||||
@@ -37,10 +41,16 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AvodNewMedia,
|
||||
[JsonProperty("blacklist_get_signin")]
|
||||
BlacklistGetSignin,
|
||||
[JsonProperty("boost-voices")]
|
||||
BoostVoices,
|
||||
[JsonProperty("camera_upload")]
|
||||
CameraUpload,
|
||||
[JsonProperty("client-radio-stations")]
|
||||
ClientRadioStations,
|
||||
[JsonProperty("cloudflare-turnstile-required")]
|
||||
CloudflareTurnstileRequired,
|
||||
[JsonProperty("cloudsync")]
|
||||
Cloudsync,
|
||||
[JsonProperty("collections")]
|
||||
Collections,
|
||||
[JsonProperty("comments_and_replies_push_notifications")]
|
||||
@@ -49,30 +59,50 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
CommunityAccessPlexTv,
|
||||
[JsonProperty("companions_sonos")]
|
||||
CompanionsSonos,
|
||||
[JsonProperty("content_filter")]
|
||||
ContentFilter,
|
||||
[JsonProperty("custom-home-removal")]
|
||||
CustomHomeRemoval,
|
||||
[JsonProperty("disable_home_user_friendships")]
|
||||
DisableHomeUserFriendships,
|
||||
[JsonProperty("disable_sharing_friendships")]
|
||||
DisableSharingFriendships,
|
||||
[JsonProperty("downloads-gating")]
|
||||
DownloadsGating,
|
||||
[JsonProperty("drm_support")]
|
||||
DrmSupport,
|
||||
[JsonProperty("dvr")]
|
||||
Dvr,
|
||||
[JsonProperty("dvr-block-unsupported-countries")]
|
||||
DvrBlockUnsupportedCountries,
|
||||
[JsonProperty("epg-recent-channels")]
|
||||
EpgRecentChannels,
|
||||
[JsonProperty("exclude restrictions")]
|
||||
ExcludeRestrictions,
|
||||
[JsonProperty("federated-auth")]
|
||||
FederatedAuth,
|
||||
[JsonProperty("friend_request_push_notifications")]
|
||||
FriendRequestPushNotifications,
|
||||
[JsonProperty("grandfather-sync")]
|
||||
GrandfatherSync,
|
||||
[JsonProperty("guided-upgrade")]
|
||||
GuidedUpgrade,
|
||||
[JsonProperty("hardware_transcoding")]
|
||||
HardwareTranscoding,
|
||||
[JsonProperty("home")]
|
||||
Home,
|
||||
[JsonProperty("hwtranscode")]
|
||||
Hwtranscode,
|
||||
[JsonProperty("imagga-v2")]
|
||||
ImaggaV2,
|
||||
[JsonProperty("increase-password-complexity")]
|
||||
IncreasePasswordComplexity,
|
||||
[JsonProperty("ios14-privacy-banner")]
|
||||
Ios14PrivacyBanner,
|
||||
[JsonProperty("iterable-notification-tokens")]
|
||||
IterableNotificationTokens,
|
||||
[JsonProperty("item_clusters")]
|
||||
ItemClusters,
|
||||
[JsonProperty("keep-payment-method")]
|
||||
KeepPaymentMethod,
|
||||
[JsonProperty("kevin-bacon")]
|
||||
@@ -89,34 +119,68 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
LiveTvSupportIncompleteSegments,
|
||||
[JsonProperty("livetv")]
|
||||
Livetv,
|
||||
[JsonProperty("lyrics")]
|
||||
Lyrics,
|
||||
[JsonProperty("metadata_search")]
|
||||
MetadataSearch,
|
||||
[JsonProperty("music-analysis")]
|
||||
MusicAnalysis,
|
||||
[JsonProperty("music_videos")]
|
||||
MusicVideos,
|
||||
[JsonProperty("new_plex_pass_prices")]
|
||||
NewPlexPassPrices,
|
||||
[JsonProperty("news-provider-sunset-modal")]
|
||||
NewsProviderSunsetModal,
|
||||
[JsonProperty("nominatim")]
|
||||
Nominatim,
|
||||
[JsonProperty("pass")]
|
||||
Pass,
|
||||
[JsonProperty("photos-favorites")]
|
||||
PhotosFavorites,
|
||||
[JsonProperty("photos-metadata-edition")]
|
||||
PhotosMetadataEdition,
|
||||
[JsonProperty("photosV6-edit")]
|
||||
PhotosV6Edit,
|
||||
[JsonProperty("photosV6-tv-albums")]
|
||||
PhotosV6TvAlbums,
|
||||
[JsonProperty("pms_health")]
|
||||
PmsHealth,
|
||||
[JsonProperty("premium-dashboard")]
|
||||
PremiumDashboard,
|
||||
[JsonProperty("premium_music_metadata")]
|
||||
PremiumMusicMetadata,
|
||||
[JsonProperty("radio")]
|
||||
Radio,
|
||||
[JsonProperty("rate-limit-client-token")]
|
||||
RateLimitClientToken,
|
||||
[JsonProperty("scrobbling-service-plex-tv")]
|
||||
ScrobblingServicePlexTv,
|
||||
[JsonProperty("session_bandwidth_restrictions")]
|
||||
SessionBandwidthRestrictions,
|
||||
[JsonProperty("session_kick")]
|
||||
SessionKick,
|
||||
[JsonProperty("shared_server_notification")]
|
||||
SharedServerNotification,
|
||||
[JsonProperty("shared_source_notification")]
|
||||
SharedSourceNotification,
|
||||
[JsonProperty("signin_notification")]
|
||||
SigninNotification,
|
||||
[JsonProperty("signin_with_apple")]
|
||||
SigninWithApple,
|
||||
[JsonProperty("silence-removal")]
|
||||
SilenceRemoval,
|
||||
[JsonProperty("sleep-timer")]
|
||||
SleepTimer,
|
||||
[JsonProperty("spring_serve_ad_provider")]
|
||||
SpringServeAdProvider,
|
||||
[JsonProperty("sync")]
|
||||
Sync,
|
||||
[JsonProperty("sweet-fades")]
|
||||
SweetFades,
|
||||
[JsonProperty("transcoder_cache")]
|
||||
TranscoderCache,
|
||||
[JsonProperty("trailers")]
|
||||
Trailers,
|
||||
[JsonProperty("tuner-sharing")]
|
||||
TunerSharing,
|
||||
[JsonProperty("two-factor-authentication")]
|
||||
@@ -125,14 +189,22 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
Unsupportedtuners,
|
||||
[JsonProperty("upgrade-3ds2")]
|
||||
Upgrade3ds2,
|
||||
[JsonProperty("visualizers")]
|
||||
Visualizers,
|
||||
[JsonProperty("vod-schema")]
|
||||
VodSchema,
|
||||
[JsonProperty("vod_cloudflare")]
|
||||
VodCloudflare,
|
||||
[JsonProperty("volume-leveling")]
|
||||
VolumeLeveling,
|
||||
[JsonProperty("watch-together-invite")]
|
||||
WatchTogetherInvite,
|
||||
[JsonProperty("watchlist-rss")]
|
||||
WatchlistRss,
|
||||
[JsonProperty("web_server_dashboard")]
|
||||
WebServerDashboard,
|
||||
[JsonProperty("webhooks")]
|
||||
Webhooks,
|
||||
}
|
||||
|
||||
public static class GetTokenDetailsFeaturesExtension
|
||||
|
||||
@@ -154,7 +154,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
public bool? MailingListActive { get; set; } = false;
|
||||
|
||||
/// <summary>
|
||||
/// Your current mailing list status
|
||||
/// Your current mailing list status (active or unsubscribed)
|
||||
/// </summary>
|
||||
[JsonProperty("mailingListStatus")]
|
||||
public MailingListStatus MailingListStatus { get; set; } = default!;
|
||||
|
||||
@@ -14,7 +14,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
using System;
|
||||
|
||||
/// <summary>
|
||||
/// Your current mailing list status
|
||||
/// Your current mailing list status (active or unsubscribed)
|
||||
/// </summary>
|
||||
public enum MailingListStatus
|
||||
{
|
||||
|
||||
@@ -29,6 +29,10 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AdCountdownTimer,
|
||||
[JsonProperty("adaptive_bitrate")]
|
||||
AdaptiveBitrate,
|
||||
[JsonProperty("album-types")]
|
||||
AlbumTypes,
|
||||
[JsonProperty("allow_dvr")]
|
||||
AllowDvr,
|
||||
[JsonProperty("amazon-loop-debug")]
|
||||
AmazonLoopDebug,
|
||||
[JsonProperty("avod-ad-analysis")]
|
||||
@@ -37,10 +41,16 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AvodNewMedia,
|
||||
[JsonProperty("blacklist_get_signin")]
|
||||
BlacklistGetSignin,
|
||||
[JsonProperty("boost-voices")]
|
||||
BoostVoices,
|
||||
[JsonProperty("camera_upload")]
|
||||
CameraUpload,
|
||||
[JsonProperty("client-radio-stations")]
|
||||
ClientRadioStations,
|
||||
[JsonProperty("cloudflare-turnstile-required")]
|
||||
CloudflareTurnstileRequired,
|
||||
[JsonProperty("cloudsync")]
|
||||
Cloudsync,
|
||||
[JsonProperty("collections")]
|
||||
Collections,
|
||||
[JsonProperty("comments_and_replies_push_notifications")]
|
||||
@@ -49,30 +59,50 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
CommunityAccessPlexTv,
|
||||
[JsonProperty("companions_sonos")]
|
||||
CompanionsSonos,
|
||||
[JsonProperty("content_filter")]
|
||||
ContentFilter,
|
||||
[JsonProperty("custom-home-removal")]
|
||||
CustomHomeRemoval,
|
||||
[JsonProperty("disable_home_user_friendships")]
|
||||
DisableHomeUserFriendships,
|
||||
[JsonProperty("disable_sharing_friendships")]
|
||||
DisableSharingFriendships,
|
||||
[JsonProperty("downloads-gating")]
|
||||
DownloadsGating,
|
||||
[JsonProperty("drm_support")]
|
||||
DrmSupport,
|
||||
[JsonProperty("dvr")]
|
||||
Dvr,
|
||||
[JsonProperty("dvr-block-unsupported-countries")]
|
||||
DvrBlockUnsupportedCountries,
|
||||
[JsonProperty("epg-recent-channels")]
|
||||
EpgRecentChannels,
|
||||
[JsonProperty("exclude restrictions")]
|
||||
ExcludeRestrictions,
|
||||
[JsonProperty("federated-auth")]
|
||||
FederatedAuth,
|
||||
[JsonProperty("friend_request_push_notifications")]
|
||||
FriendRequestPushNotifications,
|
||||
[JsonProperty("grandfather-sync")]
|
||||
GrandfatherSync,
|
||||
[JsonProperty("guided-upgrade")]
|
||||
GuidedUpgrade,
|
||||
[JsonProperty("hardware_transcoding")]
|
||||
HardwareTranscoding,
|
||||
[JsonProperty("home")]
|
||||
Home,
|
||||
[JsonProperty("hwtranscode")]
|
||||
Hwtranscode,
|
||||
[JsonProperty("imagga-v2")]
|
||||
ImaggaV2,
|
||||
[JsonProperty("increase-password-complexity")]
|
||||
IncreasePasswordComplexity,
|
||||
[JsonProperty("ios14-privacy-banner")]
|
||||
Ios14PrivacyBanner,
|
||||
[JsonProperty("iterable-notification-tokens")]
|
||||
IterableNotificationTokens,
|
||||
[JsonProperty("item_clusters")]
|
||||
ItemClusters,
|
||||
[JsonProperty("keep-payment-method")]
|
||||
KeepPaymentMethod,
|
||||
[JsonProperty("kevin-bacon")]
|
||||
@@ -89,34 +119,68 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
LiveTvSupportIncompleteSegments,
|
||||
[JsonProperty("livetv")]
|
||||
Livetv,
|
||||
[JsonProperty("lyrics")]
|
||||
Lyrics,
|
||||
[JsonProperty("metadata_search")]
|
||||
MetadataSearch,
|
||||
[JsonProperty("music-analysis")]
|
||||
MusicAnalysis,
|
||||
[JsonProperty("music_videos")]
|
||||
MusicVideos,
|
||||
[JsonProperty("new_plex_pass_prices")]
|
||||
NewPlexPassPrices,
|
||||
[JsonProperty("news-provider-sunset-modal")]
|
||||
NewsProviderSunsetModal,
|
||||
[JsonProperty("nominatim")]
|
||||
Nominatim,
|
||||
[JsonProperty("pass")]
|
||||
Pass,
|
||||
[JsonProperty("photos-favorites")]
|
||||
PhotosFavorites,
|
||||
[JsonProperty("photos-metadata-edition")]
|
||||
PhotosMetadataEdition,
|
||||
[JsonProperty("photosV6-edit")]
|
||||
PhotosV6Edit,
|
||||
[JsonProperty("photosV6-tv-albums")]
|
||||
PhotosV6TvAlbums,
|
||||
[JsonProperty("pms_health")]
|
||||
PmsHealth,
|
||||
[JsonProperty("premium-dashboard")]
|
||||
PremiumDashboard,
|
||||
[JsonProperty("premium_music_metadata")]
|
||||
PremiumMusicMetadata,
|
||||
[JsonProperty("radio")]
|
||||
Radio,
|
||||
[JsonProperty("rate-limit-client-token")]
|
||||
RateLimitClientToken,
|
||||
[JsonProperty("scrobbling-service-plex-tv")]
|
||||
ScrobblingServicePlexTv,
|
||||
[JsonProperty("session_bandwidth_restrictions")]
|
||||
SessionBandwidthRestrictions,
|
||||
[JsonProperty("session_kick")]
|
||||
SessionKick,
|
||||
[JsonProperty("shared_server_notification")]
|
||||
SharedServerNotification,
|
||||
[JsonProperty("shared_source_notification")]
|
||||
SharedSourceNotification,
|
||||
[JsonProperty("signin_notification")]
|
||||
SigninNotification,
|
||||
[JsonProperty("signin_with_apple")]
|
||||
SigninWithApple,
|
||||
[JsonProperty("silence-removal")]
|
||||
SilenceRemoval,
|
||||
[JsonProperty("sleep-timer")]
|
||||
SleepTimer,
|
||||
[JsonProperty("spring_serve_ad_provider")]
|
||||
SpringServeAdProvider,
|
||||
[JsonProperty("sync")]
|
||||
Sync,
|
||||
[JsonProperty("sweet-fades")]
|
||||
SweetFades,
|
||||
[JsonProperty("transcoder_cache")]
|
||||
TranscoderCache,
|
||||
[JsonProperty("trailers")]
|
||||
Trailers,
|
||||
[JsonProperty("tuner-sharing")]
|
||||
TunerSharing,
|
||||
[JsonProperty("two-factor-authentication")]
|
||||
@@ -125,14 +189,22 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
Unsupportedtuners,
|
||||
[JsonProperty("upgrade-3ds2")]
|
||||
Upgrade3ds2,
|
||||
[JsonProperty("visualizers")]
|
||||
Visualizers,
|
||||
[JsonProperty("vod-schema")]
|
||||
VodSchema,
|
||||
[JsonProperty("vod_cloudflare")]
|
||||
VodCloudflare,
|
||||
[JsonProperty("volume-leveling")]
|
||||
VolumeLeveling,
|
||||
[JsonProperty("watch-together-invite")]
|
||||
WatchTogetherInvite,
|
||||
[JsonProperty("watchlist-rss")]
|
||||
WatchlistRss,
|
||||
[JsonProperty("web_server_dashboard")]
|
||||
WebServerDashboard,
|
||||
[JsonProperty("webhooks")]
|
||||
Webhooks,
|
||||
}
|
||||
|
||||
public static class PostUsersSignInDataAuthenticationFeaturesExtension
|
||||
|
||||
@@ -29,6 +29,10 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AdCountdownTimer,
|
||||
[JsonProperty("adaptive_bitrate")]
|
||||
AdaptiveBitrate,
|
||||
[JsonProperty("album-types")]
|
||||
AlbumTypes,
|
||||
[JsonProperty("allow_dvr")]
|
||||
AllowDvr,
|
||||
[JsonProperty("amazon-loop-debug")]
|
||||
AmazonLoopDebug,
|
||||
[JsonProperty("avod-ad-analysis")]
|
||||
@@ -37,10 +41,16 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
AvodNewMedia,
|
||||
[JsonProperty("blacklist_get_signin")]
|
||||
BlacklistGetSignin,
|
||||
[JsonProperty("boost-voices")]
|
||||
BoostVoices,
|
||||
[JsonProperty("camera_upload")]
|
||||
CameraUpload,
|
||||
[JsonProperty("client-radio-stations")]
|
||||
ClientRadioStations,
|
||||
[JsonProperty("cloudflare-turnstile-required")]
|
||||
CloudflareTurnstileRequired,
|
||||
[JsonProperty("cloudsync")]
|
||||
Cloudsync,
|
||||
[JsonProperty("collections")]
|
||||
Collections,
|
||||
[JsonProperty("comments_and_replies_push_notifications")]
|
||||
@@ -49,30 +59,50 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
CommunityAccessPlexTv,
|
||||
[JsonProperty("companions_sonos")]
|
||||
CompanionsSonos,
|
||||
[JsonProperty("content_filter")]
|
||||
ContentFilter,
|
||||
[JsonProperty("custom-home-removal")]
|
||||
CustomHomeRemoval,
|
||||
[JsonProperty("disable_home_user_friendships")]
|
||||
DisableHomeUserFriendships,
|
||||
[JsonProperty("disable_sharing_friendships")]
|
||||
DisableSharingFriendships,
|
||||
[JsonProperty("downloads-gating")]
|
||||
DownloadsGating,
|
||||
[JsonProperty("drm_support")]
|
||||
DrmSupport,
|
||||
[JsonProperty("dvr")]
|
||||
Dvr,
|
||||
[JsonProperty("dvr-block-unsupported-countries")]
|
||||
DvrBlockUnsupportedCountries,
|
||||
[JsonProperty("epg-recent-channels")]
|
||||
EpgRecentChannels,
|
||||
[JsonProperty("exclude restrictions")]
|
||||
ExcludeRestrictions,
|
||||
[JsonProperty("federated-auth")]
|
||||
FederatedAuth,
|
||||
[JsonProperty("friend_request_push_notifications")]
|
||||
FriendRequestPushNotifications,
|
||||
[JsonProperty("grandfather-sync")]
|
||||
GrandfatherSync,
|
||||
[JsonProperty("guided-upgrade")]
|
||||
GuidedUpgrade,
|
||||
[JsonProperty("hardware_transcoding")]
|
||||
HardwareTranscoding,
|
||||
[JsonProperty("home")]
|
||||
Home,
|
||||
[JsonProperty("hwtranscode")]
|
||||
Hwtranscode,
|
||||
[JsonProperty("imagga-v2")]
|
||||
ImaggaV2,
|
||||
[JsonProperty("increase-password-complexity")]
|
||||
IncreasePasswordComplexity,
|
||||
[JsonProperty("ios14-privacy-banner")]
|
||||
Ios14PrivacyBanner,
|
||||
[JsonProperty("iterable-notification-tokens")]
|
||||
IterableNotificationTokens,
|
||||
[JsonProperty("item_clusters")]
|
||||
ItemClusters,
|
||||
[JsonProperty("keep-payment-method")]
|
||||
KeepPaymentMethod,
|
||||
[JsonProperty("kevin-bacon")]
|
||||
@@ -89,34 +119,68 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
LiveTvSupportIncompleteSegments,
|
||||
[JsonProperty("livetv")]
|
||||
Livetv,
|
||||
[JsonProperty("lyrics")]
|
||||
Lyrics,
|
||||
[JsonProperty("metadata_search")]
|
||||
MetadataSearch,
|
||||
[JsonProperty("music-analysis")]
|
||||
MusicAnalysis,
|
||||
[JsonProperty("music_videos")]
|
||||
MusicVideos,
|
||||
[JsonProperty("new_plex_pass_prices")]
|
||||
NewPlexPassPrices,
|
||||
[JsonProperty("news-provider-sunset-modal")]
|
||||
NewsProviderSunsetModal,
|
||||
[JsonProperty("nominatim")]
|
||||
Nominatim,
|
||||
[JsonProperty("pass")]
|
||||
Pass,
|
||||
[JsonProperty("photos-favorites")]
|
||||
PhotosFavorites,
|
||||
[JsonProperty("photos-metadata-edition")]
|
||||
PhotosMetadataEdition,
|
||||
[JsonProperty("photosV6-edit")]
|
||||
PhotosV6Edit,
|
||||
[JsonProperty("photosV6-tv-albums")]
|
||||
PhotosV6TvAlbums,
|
||||
[JsonProperty("pms_health")]
|
||||
PmsHealth,
|
||||
[JsonProperty("premium-dashboard")]
|
||||
PremiumDashboard,
|
||||
[JsonProperty("premium_music_metadata")]
|
||||
PremiumMusicMetadata,
|
||||
[JsonProperty("radio")]
|
||||
Radio,
|
||||
[JsonProperty("rate-limit-client-token")]
|
||||
RateLimitClientToken,
|
||||
[JsonProperty("scrobbling-service-plex-tv")]
|
||||
ScrobblingServicePlexTv,
|
||||
[JsonProperty("session_bandwidth_restrictions")]
|
||||
SessionBandwidthRestrictions,
|
||||
[JsonProperty("session_kick")]
|
||||
SessionKick,
|
||||
[JsonProperty("shared_server_notification")]
|
||||
SharedServerNotification,
|
||||
[JsonProperty("shared_source_notification")]
|
||||
SharedSourceNotification,
|
||||
[JsonProperty("signin_notification")]
|
||||
SigninNotification,
|
||||
[JsonProperty("signin_with_apple")]
|
||||
SigninWithApple,
|
||||
[JsonProperty("silence-removal")]
|
||||
SilenceRemoval,
|
||||
[JsonProperty("sleep-timer")]
|
||||
SleepTimer,
|
||||
[JsonProperty("spring_serve_ad_provider")]
|
||||
SpringServeAdProvider,
|
||||
[JsonProperty("sync")]
|
||||
Sync,
|
||||
[JsonProperty("sweet-fades")]
|
||||
SweetFades,
|
||||
[JsonProperty("transcoder_cache")]
|
||||
TranscoderCache,
|
||||
[JsonProperty("trailers")]
|
||||
Trailers,
|
||||
[JsonProperty("tuner-sharing")]
|
||||
TunerSharing,
|
||||
[JsonProperty("two-factor-authentication")]
|
||||
@@ -125,14 +189,22 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
Unsupportedtuners,
|
||||
[JsonProperty("upgrade-3ds2")]
|
||||
Upgrade3ds2,
|
||||
[JsonProperty("visualizers")]
|
||||
Visualizers,
|
||||
[JsonProperty("vod-schema")]
|
||||
VodSchema,
|
||||
[JsonProperty("vod_cloudflare")]
|
||||
VodCloudflare,
|
||||
[JsonProperty("volume-leveling")]
|
||||
VolumeLeveling,
|
||||
[JsonProperty("watch-together-invite")]
|
||||
WatchTogetherInvite,
|
||||
[JsonProperty("watchlist-rss")]
|
||||
WatchlistRss,
|
||||
[JsonProperty("web_server_dashboard")]
|
||||
WebServerDashboard,
|
||||
[JsonProperty("webhooks")]
|
||||
Webhooks,
|
||||
}
|
||||
|
||||
public static class PostUsersSignInDataFeaturesExtension
|
||||
|
||||
@@ -14,7 +14,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
using System;
|
||||
|
||||
/// <summary>
|
||||
/// Your current mailing list status
|
||||
/// Your current mailing list status (active or unsubscribed)
|
||||
/// </summary>
|
||||
public enum PostUsersSignInDataMailingListStatus
|
||||
{
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
//------------------------------------------------------------------------------
|
||||
// <auto-generated>
|
||||
// This code was generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
//
|
||||
// Changes to this file may cause incorrect behavior and will be lost when
|
||||
// the code is regenerated.
|
||||
// </auto-generated>
|
||||
//------------------------------------------------------------------------------
|
||||
#nullable enable
|
||||
namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
{
|
||||
using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
using LukeHagar.PlexAPI.SDK.Utils;
|
||||
|
||||
public class PostUsersSignInDataRequest
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// The unique identifier for the client application<br/>
|
||||
///
|
||||
/// <remarks>
|
||||
/// This is used to track the client application and its usage<br/>
|
||||
/// (UUID, serial number, or other number unique per device)<br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Client-Identifier")]
|
||||
public string? ClientID { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Product")]
|
||||
public string? ClientName { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Device")]
|
||||
public string? DeviceName { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Version")]
|
||||
public string? ClientVersion { get; set; }
|
||||
|
||||
[SpeakeasyMetadata("queryParam:style=form,explode=true,name=X-Plex-Platform")]
|
||||
public string? ClientPlatform { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Login credentials
|
||||
/// </summary>
|
||||
[SpeakeasyMetadata("request:mediaType=application/x-www-form-urlencoded")]
|
||||
public PostUsersSignInDataRequestBody? RequestBody { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -154,7 +154,7 @@ namespace LukeHagar.PlexAPI.SDK.Models.Requests
|
||||
public bool? MailingListActive { get; set; } = false;
|
||||
|
||||
/// <summary>
|
||||
/// Your current mailing list status
|
||||
/// Your current mailing list status (active or unsubscribed)
|
||||
/// </summary>
|
||||
[JsonProperty("mailingListStatus")]
|
||||
public PostUsersSignInDataMailingListStatus MailingListStatus { get; set; } = default!;
|
||||
|
||||
@@ -146,10 +146,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -75,7 +75,7 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
/// Get Plex server access tokens and server connections
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
Task<GetServerResourcesResponse> GetServerResourcesAsync(IncludeHttps? includeHttps = null, IncludeRelay? includeRelay = null, IncludeIPv6? includeIPv6 = null, string? serverUrl = null);
|
||||
Task<GetServerResourcesResponse> GetServerResourcesAsync(IncludeHttps? includeHttps = null, IncludeRelay? includeRelay = null, IncludeIPv6? includeIPv6 = null, string? clientID = null, string? serverUrl = null);
|
||||
|
||||
/// <summary>
|
||||
/// Get a Pin
|
||||
@@ -93,7 +93,7 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
/// Retrieve an Access Token from Plex.tv after the Pin has been authenticated
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
Task<GetTokenByPinIdResponse> GetTokenByPinIdAsync(long pinID, string? serverUrl = null);
|
||||
Task<GetTokenByPinIdResponse> GetTokenByPinIdAsync(GetTokenByPinIdRequest request, string? serverUrl = null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -109,44 +109,44 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
/// List of server URLs available for the getCompanionsData operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetCompanionsDataServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the getUserFriends operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetUserFriendsServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the getGeoData operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetGeoDataServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the get-server-resources operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetServerResourcesServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the getPin operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetPinServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
/// <summary>
|
||||
/// List of server URLs available for the getTokenByPinId operation.
|
||||
/// </summary>
|
||||
public static readonly string[] GetTokenByPinIdServerList = {
|
||||
"https://plex.tv/api/v2/",
|
||||
"https://plex.tv/api/v2",
|
||||
};
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
@@ -557,14 +557,17 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse);
|
||||
}
|
||||
|
||||
public async Task<GetServerResourcesResponse> GetServerResourcesAsync(IncludeHttps? includeHttps = null, IncludeRelay? includeRelay = null, IncludeIPv6? includeIPv6 = null, string? serverUrl = null)
|
||||
public async Task<GetServerResourcesResponse> GetServerResourcesAsync(IncludeHttps? includeHttps = null, IncludeRelay? includeRelay = null, IncludeIPv6? includeIPv6 = null, string? clientID = null, string? serverUrl = null)
|
||||
{
|
||||
var request = new GetServerResourcesRequest()
|
||||
{
|
||||
IncludeHttps = includeHttps,
|
||||
IncludeRelay = includeRelay,
|
||||
IncludeIPv6 = includeIPv6,
|
||||
ClientID = clientID,
|
||||
};
|
||||
request.ClientID ??= SDKConfiguration.ClientID;
|
||||
|
||||
string baseUrl = Utilities.TemplateUrl(GetServerResourcesServerList[0], new Dictionary<string, string>(){
|
||||
});
|
||||
if (serverUrl != null)
|
||||
@@ -666,6 +669,7 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
|
||||
public async Task<GetPinResponse> GetPinAsync(GetPinRequest? request = null, string? serverUrl = null)
|
||||
{
|
||||
request.ClientID ??= SDKConfiguration.ClientID;
|
||||
request.ClientName ??= SDKConfiguration.ClientName;
|
||||
request.ClientVersion ??= SDKConfiguration.ClientVersion;
|
||||
request.ClientPlatform ??= SDKConfiguration.ClientPlatform;
|
||||
@@ -754,12 +758,18 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
throw new Models.Errors.SDKException("Unknown status code received", responseStatusCode, await httpResponse.Content.ReadAsStringAsync(), httpResponse);
|
||||
}
|
||||
|
||||
public async Task<GetTokenByPinIdResponse> GetTokenByPinIdAsync(long pinID, string? serverUrl = null)
|
||||
public async Task<GetTokenByPinIdResponse> GetTokenByPinIdAsync(GetTokenByPinIdRequest request, string? serverUrl = null)
|
||||
{
|
||||
var request = new GetTokenByPinIdRequest()
|
||||
if (request == null)
|
||||
{
|
||||
PinID = pinID,
|
||||
};
|
||||
request = new GetTokenByPinIdRequest();
|
||||
}
|
||||
request.ClientID ??= SDKConfiguration.ClientID;
|
||||
request.ClientName ??= SDKConfiguration.ClientName;
|
||||
request.ClientVersion ??= SDKConfiguration.ClientVersion;
|
||||
request.ClientPlatform ??= SDKConfiguration.ClientPlatform;
|
||||
request.DeviceName ??= SDKConfiguration.DeviceName;
|
||||
|
||||
string baseUrl = Utilities.TemplateUrl(GetTokenByPinIdServerList[0], new Dictionary<string, string>(){
|
||||
});
|
||||
if (serverUrl != null)
|
||||
|
||||
@@ -67,6 +67,34 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
|
||||
/// <summary>
|
||||
/// Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
///
|
||||
/// <remarks>
|
||||
/// # Plex Media Server OpenAPI Specification<br/>
|
||||
/// <br/>
|
||||
/// An Open Source OpenAPI Specification for Plex Media Server<br/>
|
||||
/// <br/>
|
||||
/// Automation and SDKs provided by <a href="https://speakeasyapi.dev/">Speakeasy</a><br/>
|
||||
/// <br/>
|
||||
/// ## Documentation<br/>
|
||||
/// <br/>
|
||||
/// <a href="https://plexapi.dev">API Documentation</a><br/>
|
||||
/// <br/>
|
||||
/// ## SDKs<br/>
|
||||
/// <br/>
|
||||
/// 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 <a href="https://github.com/LukeHagar/plex-api-spec">main specification Repository</a>.<br/>
|
||||
/// <br/>
|
||||
/// | Language | Repository | Releases | Other |<br/>
|
||||
/// | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |<br/>
|
||||
/// | Python | <a href="https://github.com/LukeHagar/plexpy">GitHub</a> | <a href="https://pypi.org/project/plex-api-client/">PyPI</a> | - |<br/>
|
||||
/// | JavaScript/TypeScript | <a href="https://github.com/LukeHagar/plexjs">GitHub</a> | <a href="https://www.npmjs.com/package/@lukehagar/plexjs">NPM</a> \ <a href="https://jsr.io/@lukehagar/plexjs">JSR</a> | - |<br/>
|
||||
/// | Go | <a href="https://github.com/LukeHagar/plexgo">GitHub</a> | <a href="https://github.com/LukeHagar/plexgo/releases">Releases</a> | <a href="https://pkg.go.dev/github.com/LukeHagar/plexgo">GoDoc</a> |<br/>
|
||||
/// | Ruby | <a href="https://github.com/LukeHagar/plexruby">GitHub</a> | <a href="https://github.com/LukeHagar/plexruby/releases">Releases</a> | - |<br/>
|
||||
/// | Swift | <a href="https://github.com/LukeHagar/plexswift">GitHub</a> | <a href="https://github.com/LukeHagar/plexswift/releases">Releases</a> | - |<br/>
|
||||
/// | PHP | <a href="https://github.com/LukeHagar/plexphp">GitHub</a> | <a href="https://github.com/LukeHagar/plexphp/releases">Releases</a> | - |<br/>
|
||||
/// | Java | <a href="https://github.com/LukeHagar/plexjava">GitHub</a> | <a href="https://github.com/LukeHagar/plexjava/releases">Releases</a> | - |<br/>
|
||||
/// | C# | <a href="https://github.com/LukeHagar/plexcsharp">GitHub</a> | <a href="https://github.com/LukeHagar/plexcsharp/releases">Releases</a> | - <br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
public interface IPlexAPI
|
||||
{
|
||||
@@ -269,16 +297,44 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
|
||||
/// <summary>
|
||||
/// Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
///
|
||||
/// <remarks>
|
||||
/// # Plex Media Server OpenAPI Specification<br/>
|
||||
/// <br/>
|
||||
/// An Open Source OpenAPI Specification for Plex Media Server<br/>
|
||||
/// <br/>
|
||||
/// Automation and SDKs provided by <a href="https://speakeasyapi.dev/">Speakeasy</a><br/>
|
||||
/// <br/>
|
||||
/// ## Documentation<br/>
|
||||
/// <br/>
|
||||
/// <a href="https://plexapi.dev">API Documentation</a><br/>
|
||||
/// <br/>
|
||||
/// ## SDKs<br/>
|
||||
/// <br/>
|
||||
/// 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 <a href="https://github.com/LukeHagar/plex-api-spec">main specification Repository</a>.<br/>
|
||||
/// <br/>
|
||||
/// | Language | Repository | Releases | Other |<br/>
|
||||
/// | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |<br/>
|
||||
/// | Python | <a href="https://github.com/LukeHagar/plexpy">GitHub</a> | <a href="https://pypi.org/project/plex-api-client/">PyPI</a> | - |<br/>
|
||||
/// | JavaScript/TypeScript | <a href="https://github.com/LukeHagar/plexjs">GitHub</a> | <a href="https://www.npmjs.com/package/@lukehagar/plexjs">NPM</a> \ <a href="https://jsr.io/@lukehagar/plexjs">JSR</a> | - |<br/>
|
||||
/// | Go | <a href="https://github.com/LukeHagar/plexgo">GitHub</a> | <a href="https://github.com/LukeHagar/plexgo/releases">Releases</a> | <a href="https://pkg.go.dev/github.com/LukeHagar/plexgo">GoDoc</a> |<br/>
|
||||
/// | Ruby | <a href="https://github.com/LukeHagar/plexruby">GitHub</a> | <a href="https://github.com/LukeHagar/plexruby/releases">Releases</a> | - |<br/>
|
||||
/// | Swift | <a href="https://github.com/LukeHagar/plexswift">GitHub</a> | <a href="https://github.com/LukeHagar/plexswift/releases">Releases</a> | - |<br/>
|
||||
/// | PHP | <a href="https://github.com/LukeHagar/plexphp">GitHub</a> | <a href="https://github.com/LukeHagar/plexphp/releases">Releases</a> | - |<br/>
|
||||
/// | Java | <a href="https://github.com/LukeHagar/plexjava">GitHub</a> | <a href="https://github.com/LukeHagar/plexjava/releases">Releases</a> | - |<br/>
|
||||
/// | C# | <a href="https://github.com/LukeHagar/plexcsharp">GitHub</a> | <a href="https://github.com/LukeHagar/plexcsharp/releases">Releases</a> | - <br/>
|
||||
///
|
||||
/// </remarks>
|
||||
/// </summary>
|
||||
public class PlexAPI: IPlexAPI
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private int _serverIndex = 0;
|
||||
private ISpeakeasyHttpClient _client;
|
||||
|
||||
@@ -87,10 +87,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -126,10 +126,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -80,10 +80,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -71,10 +71,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -74,10 +74,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -62,10 +62,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
{
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
@@ -59,10 +59,10 @@ namespace LukeHagar.PlexAPI.SDK
|
||||
};
|
||||
public SDKConfig SDKConfiguration { get; private set; }
|
||||
private const string _language = "csharp";
|
||||
private const string _sdkVersion = "0.8.0";
|
||||
private const string _sdkGenVersion = "2.422.22";
|
||||
private const string _sdkVersion = "0.8.6";
|
||||
private const string _sdkGenVersion = "2.428.1";
|
||||
private const string _openapiDocVersion = "0.0.3";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.0 2.422.22 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private const string _userAgent = "speakeasy-sdk/csharp 0.8.6 2.428.1 0.0.3 LukeHagar.PlexAPI.SDK";
|
||||
private string _serverUrl = "";
|
||||
private ISpeakeasyHttpClient _client;
|
||||
private Func<LukeHagar.PlexAPI.SDK.Models.Components.Security>? _securitySource;
|
||||
|
||||
33
NUGET.md
33
NUGET.md
@@ -32,7 +32,7 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
|
||||
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
|
||||
@@ -59,6 +59,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
|
||||
var sdk = new PlexAPI(
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
@@ -66,9 +67,12 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
GetPinRequest req = new GetPinRequest() {};
|
||||
|
||||
var res = await sdk.Plex.GetPinAsync(req);
|
||||
var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.Enable,
|
||||
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.Enable,
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable,
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40"
|
||||
);
|
||||
|
||||
// handle response
|
||||
```
|
||||
@@ -77,13 +81,24 @@ var res = await sdk.Plex.GetPinAsync(req);
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
By default, an API error will raise a `LukeHagar.PlexAPI.SDK.Models.Errors.SDKException` exception, which has the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
|---------------|-----------------------|-----------------------|
|
||||
| `Message` | *string* | The error message |
|
||||
| `StatusCode` | *int* | The HTTP status code |
|
||||
| `RawResponse` | *HttpResponseMessage* | The raw HTTP response |
|
||||
| `Body` | *string* | The response content |
|
||||
|
||||
When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `GetServerCapabilitiesAsync` method throws the following exceptions:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -120,7 +135,7 @@ catch (Exception ex)
|
||||
// Handle exception data
|
||||
throw;
|
||||
}
|
||||
else if (ex is Models.Errors.SDKException)
|
||||
else if (ex is LukeHagar.PlexAPI.SDK.Models.Errors.SDKException)
|
||||
{
|
||||
// Handle default exception
|
||||
throw;
|
||||
@@ -170,7 +185,7 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2/");
|
||||
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2");
|
||||
|
||||
// handle response
|
||||
```
|
||||
|
||||
58
README.md
58
README.md
@@ -223,7 +223,7 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2/");
|
||||
var res = await sdk.Plex.GetCompanionsDataAsync(serverUrl: "https://plex.tv/api/v2");
|
||||
|
||||
// handle response
|
||||
```
|
||||
@@ -267,7 +267,7 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
|
||||
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
|
||||
@@ -294,6 +294,7 @@ using LukeHagar.PlexAPI.SDK.Models.Requests;
|
||||
using LukeHagar.PlexAPI.SDK.Models.Components;
|
||||
|
||||
var sdk = new PlexAPI(
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40",
|
||||
clientName: "Plex Web",
|
||||
clientVersion: "4.133.0",
|
||||
@@ -301,9 +302,12 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
GetPinRequest req = new GetPinRequest() {};
|
||||
|
||||
var res = await sdk.Plex.GetPinAsync(req);
|
||||
var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.Enable,
|
||||
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.Enable,
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable,
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40"
|
||||
);
|
||||
|
||||
// handle response
|
||||
```
|
||||
@@ -312,13 +316,24 @@ var res = await sdk.Plex.GetPinAsync(req);
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
By default, an API error will raise a `LukeHagar.PlexAPI.SDK.Models.Errors.SDKException` exception, which has the following properties:
|
||||
|
||||
| Property | Type | Description |
|
||||
|---------------|-----------------------|-----------------------|
|
||||
| `Message` | *string* | The error message |
|
||||
| `StatusCode` | *int* | The HTTP status code |
|
||||
| `RawResponse` | *HttpResponseMessage* | The raw HTTP response |
|
||||
| `Body` | *string* | The response content |
|
||||
|
||||
When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `GetServerCapabilitiesAsync` method throws the following exceptions:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -355,7 +370,7 @@ catch (Exception ex)
|
||||
// Handle exception data
|
||||
throw;
|
||||
}
|
||||
else if (ex is Models.Errors.SDKException)
|
||||
else if (ex is LukeHagar.PlexAPI.SDK.Models.Errors.SDKException)
|
||||
{
|
||||
// Handle default exception
|
||||
throw;
|
||||
@@ -368,6 +383,31 @@ catch (Exception ex)
|
||||
## 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) | -
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
|
||||
60
RELEASES.md
60
RELEASES.md
@@ -265,3 +265,63 @@ Based on:
|
||||
- [csharp v0.8.0] .
|
||||
### Releases
|
||||
- [NuGet v0.8.0] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.0 - .
|
||||
|
||||
## 2024-09-26 00:20:47
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.1] .
|
||||
### Releases
|
||||
- [NuGet v0.8.1] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.1 - .
|
||||
|
||||
## 2024-09-28 00:20:26
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.2] .
|
||||
### Releases
|
||||
- [NuGet v0.8.2] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.2 - .
|
||||
|
||||
## 2024-09-29 00:23:13
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.3] .
|
||||
### Releases
|
||||
- [NuGet v0.8.3] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.3 - .
|
||||
|
||||
## 2024-09-30 00:21:52
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.4] .
|
||||
### Releases
|
||||
- [NuGet v0.8.4] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.4 - .
|
||||
|
||||
## 2024-09-30 08:46:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.5] .
|
||||
### Releases
|
||||
- [NuGet v0.8.5] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.5 - .
|
||||
|
||||
## 2024-09-30 17:22:05
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.4 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [csharp v0.8.6] .
|
||||
### Releases
|
||||
- [NuGet v0.8.6] https://www.nuget.org/packages/LukeHagar.PlexAPI.SDK/0.8.6 - .
|
||||
@@ -1172,7 +1172,11 @@ actions:
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
var res = await sdk.Plex.GetTokenByPinIdAsync(pinID: 408895);
|
||||
GetTokenByPinIdRequest req = new GetTokenByPinIdRequest() {
|
||||
PinID = 408895,
|
||||
};
|
||||
|
||||
var res = await sdk.Plex.GetTokenByPinIdAsync(req);
|
||||
|
||||
// handle response
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
@@ -1420,7 +1424,8 @@ actions:
|
||||
var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.Enable,
|
||||
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.Enable,
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable,
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40"
|
||||
);
|
||||
|
||||
// handle response
|
||||
@@ -1778,10 +1783,12 @@ actions:
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
PostUsersSignInDataRequestBody req = new PostUsersSignInDataRequestBody() {
|
||||
Login = "username@email.com",
|
||||
Password = "password123",
|
||||
VerificationCode = "123456",
|
||||
PostUsersSignInDataRequest req = new PostUsersSignInDataRequest() {
|
||||
RequestBody = new PostUsersSignInDataRequestBody() {
|
||||
Login = "username@email.com",
|
||||
Password = "password123",
|
||||
VerificationCode = "123456",
|
||||
},
|
||||
};
|
||||
|
||||
var res = await sdk.Authentication.PostUsersSignInDataAsync(req);
|
||||
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `Protocol` | [Protocol](../../Models/Requests/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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `Protocol` | [Protocol](../../Models/Requests/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 | |
|
||||
@@ -12,28 +12,43 @@
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
@@ -42,25 +57,46 @@
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
@@ -3,10 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Strong` | *bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Strong` | *bool* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
|
||||
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | 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 |
|
||||
@@ -3,8 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
@@ -3,6 +3,11 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
||||
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | 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 |
|
||||
@@ -12,28 +12,43 @@
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
@@ -42,25 +57,46 @@
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
@@ -29,7 +29,7 @@ Logged in user details
|
||||
| `JoinedAt` | *long* | :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` | [MailingListStatus](../../Models/Requests/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
| `MailingListStatus` | [MailingListStatus](../../Models/Requests/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.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `Profile` | [UserProfile](../../Models/Requests/UserProfile.md) | :heavy_check_mark: | N/A | |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# MailingListStatus
|
||||
|
||||
Your current mailing list status
|
||||
Your current mailing list status (active or unsubscribed)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
@@ -12,28 +12,43 @@
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
@@ -42,25 +57,46 @@
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
@@ -12,28 +12,43 @@
|
||||
| `TREBLEShowFeatures` | TREBLE-show-features |
|
||||
| `AdCountdownTimer` | ad-countdown-timer |
|
||||
| `AdaptiveBitrate` | adaptive_bitrate |
|
||||
| `AlbumTypes` | album-types |
|
||||
| `AllowDvr` | allow_dvr |
|
||||
| `AmazonLoopDebug` | amazon-loop-debug |
|
||||
| `AvodAdAnalysis` | avod-ad-analysis |
|
||||
| `AvodNewMedia` | avod-new-media |
|
||||
| `BlacklistGetSignin` | blacklist_get_signin |
|
||||
| `BoostVoices` | boost-voices |
|
||||
| `CameraUpload` | camera_upload |
|
||||
| `ClientRadioStations` | client-radio-stations |
|
||||
| `CloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `Cloudsync` | cloudsync |
|
||||
| `Collections` | collections |
|
||||
| `CommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `CommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `CompanionsSonos` | companions_sonos |
|
||||
| `ContentFilter` | content_filter |
|
||||
| `CustomHomeRemoval` | custom-home-removal |
|
||||
| `DisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `DisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `DownloadsGating` | downloads-gating |
|
||||
| `DrmSupport` | drm_support |
|
||||
| `Dvr` | dvr |
|
||||
| `DvrBlockUnsupportedCountries` | dvr-block-unsupported-countries |
|
||||
| `EpgRecentChannels` | epg-recent-channels |
|
||||
| `ExcludeRestrictions` | exclude restrictions |
|
||||
| `FederatedAuth` | federated-auth |
|
||||
| `FriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `GrandfatherSync` | grandfather-sync |
|
||||
| `GuidedUpgrade` | guided-upgrade |
|
||||
| `HardwareTranscoding` | hardware_transcoding |
|
||||
| `Home` | home |
|
||||
| `Hwtranscode` | hwtranscode |
|
||||
| `ImaggaV2` | imagga-v2 |
|
||||
| `IncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `Ios14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `IterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `ItemClusters` | item_clusters |
|
||||
| `KeepPaymentMethod` | keep-payment-method |
|
||||
| `KevinBacon` | kevin-bacon |
|
||||
| `KoreaConsent` | korea-consent |
|
||||
@@ -42,25 +57,46 @@
|
||||
| `LightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `LiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `Livetv` | livetv |
|
||||
| `Lyrics` | lyrics |
|
||||
| `MetadataSearch` | metadata_search |
|
||||
| `MusicAnalysis` | music-analysis |
|
||||
| `MusicVideos` | music_videos |
|
||||
| `NewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `NewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `Nominatim` | nominatim |
|
||||
| `Pass` | pass |
|
||||
| `PhotosFavorites` | photos-favorites |
|
||||
| `PhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `PhotosV6Edit` | photosV6-edit |
|
||||
| `PhotosV6TvAlbums` | photosV6-tv-albums |
|
||||
| `PmsHealth` | pms_health |
|
||||
| `PremiumDashboard` | premium-dashboard |
|
||||
| `PremiumMusicMetadata` | premium_music_metadata |
|
||||
| `Radio` | radio |
|
||||
| `RateLimitClientToken` | rate-limit-client-token |
|
||||
| `ScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `SessionBandwidthRestrictions` | session_bandwidth_restrictions |
|
||||
| `SessionKick` | session_kick |
|
||||
| `SharedServerNotification` | shared_server_notification |
|
||||
| `SharedSourceNotification` | shared_source_notification |
|
||||
| `SigninNotification` | signin_notification |
|
||||
| `SigninWithApple` | signin_with_apple |
|
||||
| `SilenceRemoval` | silence-removal |
|
||||
| `SleepTimer` | sleep-timer |
|
||||
| `SpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `Sync` | sync |
|
||||
| `SweetFades` | sweet-fades |
|
||||
| `TranscoderCache` | transcoder_cache |
|
||||
| `Trailers` | trailers |
|
||||
| `TunerSharing` | tuner-sharing |
|
||||
| `TwoFactorAuthentication` | two-factor-authentication |
|
||||
| `Unsupportedtuners` | unsupportedtuners |
|
||||
| `Upgrade3ds2` | upgrade-3ds2 |
|
||||
| `Visualizers` | visualizers |
|
||||
| `VodSchema` | vod-schema |
|
||||
| `VodCloudflare` | vod_cloudflare |
|
||||
| `VolumeLeveling` | volume-leveling |
|
||||
| `WatchTogetherInvite` | watch-together-invite |
|
||||
| `WatchlistRss` | watchlist-rss |
|
||||
| `WebServerDashboard` | web_server_dashboard |
|
||||
| `Webhooks` | webhooks |
|
||||
@@ -1,6 +1,6 @@
|
||||
# PostUsersSignInDataMailingListStatus
|
||||
|
||||
Your current mailing list status
|
||||
Your current mailing list status (active or unsubscribed)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
13
docs/Models/Requests/PostUsersSignInDataRequest.md
Normal file
13
docs/Models/Requests/PostUsersSignInDataRequest.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# PostUsersSignInDataRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | 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` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
|
||||
@@ -29,7 +29,7 @@ Returns the user account data with a valid auth token
|
||||
| `JoinedAt` | *long* | :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` | [PostUsersSignInDataMailingListStatus](../../Models/Requests/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||||
| `MailingListStatus` | [PostUsersSignInDataMailingListStatus](../../Models/Requests/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.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||||
| `Profile` | [PostUsersSignInDataUserProfile](../../Models/Requests/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
|
||||
|
||||
@@ -47,12 +47,11 @@ var res = await sdk.Activities.GetServerActivitiesAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerActivitiesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerActivitiesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## CancelServerActivities
|
||||
|
||||
@@ -91,8 +90,8 @@ var res = await sdk.Activities.CancelServerActivitiesAsync(activityUUID: "25b71e
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CancelServerActivitiesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CancelServerActivitiesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -55,12 +55,11 @@ var res = await sdk.Authentication.GetTransientTokenAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTransientTokenBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTransientTokenUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetSourceConnectionInformation
|
||||
|
||||
@@ -101,12 +100,11 @@ var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSourceConnectionInformationBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSourceConnectionInformationUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetTokenDetails
|
||||
|
||||
@@ -144,12 +142,11 @@ var res = await sdk.Authentication.GetTokenDetailsAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTokenDetailsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTokenDetailsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## PostUsersSignInData
|
||||
|
||||
@@ -170,10 +167,12 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
PostUsersSignInDataRequestBody req = new PostUsersSignInDataRequestBody() {
|
||||
Login = "username@email.com",
|
||||
Password = "password123",
|
||||
VerificationCode = "123456",
|
||||
PostUsersSignInDataRequest req = new PostUsersSignInDataRequest() {
|
||||
RequestBody = new PostUsersSignInDataRequestBody() {
|
||||
Login = "username@email.com",
|
||||
Password = "password123",
|
||||
VerificationCode = "123456",
|
||||
},
|
||||
};
|
||||
|
||||
var res = await sdk.Authentication.PostUsersSignInDataAsync(req);
|
||||
@@ -183,10 +182,10 @@ var res = await sdk.Authentication.PostUsersSignInDataAsync(req);
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `request` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `request` | [PostUsersSignInDataRequest](../../Models/Requests/PostUsersSignInDataRequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -194,8 +193,8 @@ var res = await sdk.Authentication.PostUsersSignInDataAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PostUsersSignInDataBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PostUsersSignInDataUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -44,12 +44,11 @@ var res = await sdk.Butler.GetButlerTasksAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetButlerTasksBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetButlerTasksUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StartAllTasks
|
||||
|
||||
@@ -86,12 +85,11 @@ var res = await sdk.Butler.StartAllTasksAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartAllTasksBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartAllTasksUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StopAllTasks
|
||||
|
||||
@@ -124,12 +122,11 @@ var res = await sdk.Butler.StopAllTasksAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopAllTasksBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopAllTasksUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StartTask
|
||||
|
||||
@@ -173,12 +170,11 @@ var res = await sdk.Butler.StartTaskAsync(taskName: LukeHagar.PlexAPI.SDK.Models
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartTaskBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartTaskUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StopTask
|
||||
|
||||
@@ -218,8 +214,8 @@ var res = await sdk.Butler.StopTaskAsync(taskName: LukeHagar.PlexAPI.SDK.Models.
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopTaskBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopTaskUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -53,12 +53,11 @@ var res = await sdk.Hubs.GetGlobalHubsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetGlobalHubsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetGlobalHubsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetRecentlyAdded
|
||||
|
||||
@@ -107,10 +106,9 @@ var res = await sdk.Hubs.GetRecentlyAddedAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetLibraryHubs
|
||||
|
||||
@@ -156,8 +154,8 @@ var res = await sdk.Hubs.GetLibraryHubsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryHubsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryHubsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -62,12 +62,11 @@ var res = await sdk.Library.GetFileHashAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetFileHashBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetFileHashUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetRecentlyAddedLibrary
|
||||
|
||||
@@ -131,12 +130,11 @@ var res = await sdk.Library.GetRecentlyAddedLibraryAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetRecentlyAddedLibraryBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetRecentlyAddedLibraryUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetAllLibraries
|
||||
|
||||
@@ -174,12 +172,11 @@ var res = await sdk.Library.GetAllLibrariesAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAllLibrariesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAllLibrariesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetLibraryDetails
|
||||
|
||||
@@ -261,12 +258,11 @@ var res = await sdk.Library.GetLibraryDetailsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryDetailsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryDetailsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## DeleteLibrary
|
||||
|
||||
@@ -305,12 +301,11 @@ var res = await sdk.Library.DeleteLibraryAsync(sectionKey: 9518);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.DeleteLibraryBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.DeleteLibraryUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetLibraryItems
|
||||
|
||||
@@ -379,12 +374,11 @@ var res = await sdk.Library.GetLibraryItemsAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryItemsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetLibraryItemsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetRefreshLibraryMetadata
|
||||
|
||||
@@ -428,12 +422,11 @@ var res = await sdk.Library.GetRefreshLibraryMetadataAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetRefreshLibraryMetadataBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetRefreshLibraryMetadataUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetSearchLibrary
|
||||
|
||||
@@ -494,12 +487,11 @@ var res = await sdk.Library.GetSearchLibraryAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchLibraryBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchLibraryUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMetaDataByRatingKey
|
||||
|
||||
@@ -539,12 +531,11 @@ var res = await sdk.Library.GetMetaDataByRatingKeyAsync(ratingKey: 9518);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMetaDataByRatingKeyBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMetadataChildren
|
||||
|
||||
@@ -588,12 +579,11 @@ var res = await sdk.Library.GetMetadataChildrenAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMetadataChildrenBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMetadataChildrenUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetTopWatchedContent
|
||||
|
||||
@@ -637,12 +627,11 @@ var res = await sdk.Library.GetTopWatchedContentAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTopWatchedContentBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTopWatchedContentUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetOnDeck
|
||||
|
||||
@@ -675,8 +664,8 @@ var res = await sdk.Library.GetOnDeckAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetOnDeckBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetOnDeckUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -56,12 +56,11 @@ var res = await sdk.Log.LogLineAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.LogLineBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.LogLineUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## LogMultiLine
|
||||
|
||||
@@ -124,12 +123,11 @@ var res = await sdk.Log.LogMultiLineAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.LogMultiLineBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.LogMultiLineUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## EnablePaperTrail
|
||||
|
||||
@@ -162,8 +160,8 @@ var res = await sdk.Log.EnablePaperTrailAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.EnablePaperTrailBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.EnablePaperTrailUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -51,12 +51,11 @@ var res = await sdk.Media.MarkPlayedAsync(key: 59398D);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.MarkPlayedBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.MarkPlayedUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## MarkUnplayed
|
||||
|
||||
@@ -95,12 +94,11 @@ var res = await sdk.Media.MarkUnplayedAsync(key: 59398D);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.MarkUnplayedBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.MarkUnplayedUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## UpdatePlayProgress
|
||||
|
||||
@@ -146,12 +144,11 @@ var res = await sdk.Media.UpdatePlayProgressAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UpdatePlayProgressBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UpdatePlayProgressUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetBannerImage
|
||||
|
||||
@@ -199,12 +196,11 @@ var res = await sdk.Media.GetBannerImageAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetBannerImageBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetBannerImageUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetThumbImage
|
||||
|
||||
@@ -252,8 +248,8 @@ var res = await sdk.Media.GetThumbImageAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetThumbImageBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetThumbImageUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -68,12 +68,11 @@ var res = await sdk.Playlists.CreatePlaylistAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CreatePlaylistBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CreatePlaylistUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetPlaylists
|
||||
|
||||
@@ -116,12 +115,11 @@ var res = await sdk.Playlists.GetPlaylistsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetPlaylist
|
||||
|
||||
@@ -162,12 +160,11 @@ var res = await sdk.Playlists.GetPlaylistAsync(playlistID: 4109.48D);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## DeletePlaylist
|
||||
|
||||
@@ -207,12 +204,11 @@ var res = await sdk.Playlists.DeletePlaylistAsync(playlistID: 216.22D);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.DeletePlaylistBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.DeletePlaylistUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## UpdatePlaylist
|
||||
|
||||
@@ -258,12 +254,11 @@ var res = await sdk.Playlists.UpdatePlaylistAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UpdatePlaylistBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UpdatePlaylistUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetPlaylistContents
|
||||
|
||||
@@ -310,12 +305,11 @@ var res = await sdk.Playlists.GetPlaylistContentsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistContentsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## ClearPlaylistContents
|
||||
|
||||
@@ -355,12 +349,11 @@ var res = await sdk.Playlists.ClearPlaylistContentsAsync(playlistID: 1893.18D);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.ClearPlaylistContentsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.ClearPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## AddPlaylistContents
|
||||
|
||||
@@ -407,12 +400,11 @@ var res = await sdk.Playlists.AddPlaylistContentsAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.AddPlaylistContentsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.AddPlaylistContentsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## UploadPlaylist
|
||||
|
||||
@@ -458,8 +450,8 @@ var res = await sdk.Playlists.UploadPlaylistAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UploadPlaylistBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.UploadPlaylistUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -52,12 +52,11 @@ var res = await sdk.Plex.GetCompanionsDataAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetCompanionsDataBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetCompanionsDataUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetUserFriends
|
||||
|
||||
@@ -95,12 +94,11 @@ var res = await sdk.Plex.GetUserFriendsAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUserFriendsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUserFriendsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetGeoData
|
||||
|
||||
@@ -137,12 +135,11 @@ var res = await sdk.Plex.GetGeoDataAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetGeoDataBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetGeoDataUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetHomeData
|
||||
|
||||
@@ -174,12 +171,11 @@ var res = await sdk.Plex.GetHomeDataAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetHomeDataBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetHomeDataUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetServerResources
|
||||
|
||||
@@ -204,7 +200,8 @@ var sdk = new PlexAPI(
|
||||
var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.Enable,
|
||||
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.Enable,
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable
|
||||
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable,
|
||||
clientID: "gcgzw5rz2xovp84b4vha3a40"
|
||||
);
|
||||
|
||||
// handle response
|
||||
@@ -212,12 +209,13 @@ var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `IncludeHttps` | [IncludeHttps](../../Models/Requests/IncludeHttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
|
||||
| `IncludeRelay` | [IncludeRelay](../../Models/Requests/IncludeRelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
|
||||
| `IncludeIPv6` | [IncludeIPv6](../../Models/Requests/IncludeIPv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
|
||||
| `ClientID` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -225,12 +223,11 @@ var res = await sdk.Plex.GetServerResourcesAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerResourcesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerResourcesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetPin
|
||||
|
||||
@@ -271,11 +268,10 @@ var res = await sdk.Plex.GetPinAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetPinBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetTokenByPinId
|
||||
|
||||
@@ -296,17 +292,21 @@ var sdk = new PlexAPI(
|
||||
deviceName: "Linux"
|
||||
);
|
||||
|
||||
var res = await sdk.Plex.GetTokenByPinIdAsync(pinID: 408895);
|
||||
GetTokenByPinIdRequest req = new GetTokenByPinIdRequest() {
|
||||
PinID = 408895,
|
||||
};
|
||||
|
||||
var res = await sdk.Plex.GetTokenByPinIdAsync(req);
|
||||
|
||||
// handle response
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
|
||||
| `PinID` | *long* | :heavy_check_mark: | The PinID to retrieve an access token for |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `request` | [GetTokenByPinIdRequest](../../Models/Requests/GetTokenByPinIdRequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -314,8 +314,8 @@ var res = await sdk.Plex.GetTokenByPinIdAsync(pinID: 408895);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTokenByPinIdBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTokenByPinIdResponseBody | 404 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -2,4 +2,27 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
# Plex Media Server OpenAPI Specification
|
||||
|
||||
An Open Source OpenAPI Specification for Plex Media Server
|
||||
|
||||
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
|
||||
|
||||
## Documentation
|
||||
|
||||
[API Documentation](https://plexapi.dev)
|
||||
|
||||
## SDKs
|
||||
|
||||
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
|
||||
|
||||
| Language | Repository | Releases | Other |
|
||||
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
|
||||
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
|
||||
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
|
||||
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
|
||||
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
|
||||
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
|
||||
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
|
||||
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
|
||||
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
|
||||
|
||||
@@ -67,12 +67,11 @@ var res = await sdk.Search.PerformSearchAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PerformSearchBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PerformSearchUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## PerformVoiceSearch
|
||||
|
||||
@@ -121,12 +120,11 @@ var res = await sdk.Search.PerformVoiceSearchAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PerformVoiceSearchBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.PerformVoiceSearchUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetSearchResults
|
||||
|
||||
@@ -165,8 +163,8 @@ var res = await sdk.Search.GetSearchResultsAsync(query: "110");
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchResultsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSearchResultsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -48,12 +48,11 @@ var res = await sdk.Server.GetServerCapabilitiesAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetServerPreferences
|
||||
|
||||
@@ -85,12 +84,11 @@ var res = await sdk.Server.GetServerPreferencesAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerPreferencesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerPreferencesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetAvailableClients
|
||||
|
||||
@@ -122,12 +120,11 @@ var res = await sdk.Server.GetAvailableClientsAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAvailableClientsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetAvailableClientsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetDevices
|
||||
|
||||
@@ -159,12 +156,11 @@ var res = await sdk.Server.GetDevicesAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetDevicesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetDevicesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetServerIdentity
|
||||
|
||||
@@ -195,11 +191,10 @@ var res = await sdk.Server.GetServerIdentityAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerIdentityRequestTimeout | 408 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMyPlexAccount
|
||||
|
||||
@@ -231,12 +226,11 @@ var res = await sdk.Server.GetMyPlexAccountAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMyPlexAccountBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMyPlexAccountUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetResizedPhoto
|
||||
|
||||
@@ -286,12 +280,11 @@ var res = await sdk.Server.GetResizedPhotoAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetResizedPhotoBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetResizedPhotoUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetMediaProviders
|
||||
|
||||
@@ -330,12 +323,11 @@ var res = await sdk.Server.GetMediaProvidersAsync(xPlexToken: "CV5xoxjTpFKUzBTSh
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMediaProvidersBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetMediaProvidersUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetServerList
|
||||
|
||||
@@ -367,8 +359,8 @@ var res = await sdk.Server.GetServerListAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerListBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetServerListUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -43,12 +43,11 @@ var res = await sdk.Sessions.GetSessionsAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetSessionHistory
|
||||
|
||||
@@ -95,12 +94,11 @@ var res = await sdk.Sessions.GetSessionHistoryAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionHistoryBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetSessionHistoryUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetTranscodeSessions
|
||||
|
||||
@@ -132,12 +130,11 @@ var res = await sdk.Sessions.GetTranscodeSessionsAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTranscodeSessionsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTranscodeSessionsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StopTranscodeSession
|
||||
|
||||
@@ -176,8 +173,8 @@ var res = await sdk.Sessions.StopTranscodeSessionAsync(sessionKey: "zz7llzqlx8w9
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopTranscodeSessionBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StopTranscodeSessionUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -49,12 +49,11 @@ var res = await sdk.Statistics.GetStatisticsAsync(timespan: 4);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetStatisticsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetStatisticsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetResourcesStatistics
|
||||
|
||||
@@ -93,12 +92,11 @@ var res = await sdk.Statistics.GetResourcesStatisticsAsync(timespan: 4);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetResourcesStatisticsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetResourcesStatisticsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## GetBandwidthStatistics
|
||||
|
||||
@@ -137,8 +135,8 @@ var res = await sdk.Statistics.GetBandwidthStatisticsAsync(timespan: 4);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetBandwidthStatisticsBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetBandwidthStatisticsUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -43,12 +43,11 @@ var res = await sdk.Updater.GetUpdateStatusAsync();
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUpdateStatusBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetUpdateStatusUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## CheckForUpdates
|
||||
|
||||
@@ -87,12 +86,11 @@ var res = await sdk.Updater.CheckForUpdatesAsync(download: LukeHagar.PlexAPI.SDK
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CheckForUpdatesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.CheckForUpdatesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## ApplyUpdates
|
||||
|
||||
@@ -136,8 +134,8 @@ var res = await sdk.Updater.ApplyUpdatesAsync(
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.ApplyUpdatesBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.ApplyUpdatesUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -61,12 +61,11 @@ var res = await sdk.Video.GetTimelineAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTimelineBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetTimelineUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
|
||||
## StartUniversalTranscode
|
||||
|
||||
@@ -124,8 +123,8 @@ var res = await sdk.Video.StartUniversalTranscodeAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartUniversalTranscodeBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.StartUniversalTranscodeUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
@@ -55,8 +55,8 @@ var res = await sdk.Watchlist.GetWatchListAsync(req);
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetWatchListBadRequest | 400 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.GetWatchListUnauthorized | 401 | application/json |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4xx-5xx | */* |
|
||||
| LukeHagar.PlexAPI.SDK.Models.Errors.SDKException | 4XX, 5XX | \*/\* |
|
||||
Reference in New Issue
Block a user