LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-07 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2

Browse Source
This commit is contained in:
speakeasybot
2024-09-21 00:21:00 +00:00
parent 3b6806d2db
commit 4b10ba72ca
123 changed files with 1656 additions and 2081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -84,7 +84,7 @@ var sdk = new PlexAPI(
deviceName: "Linux"
);
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "provider://provider-identifier");
// handle response
```
@@ -170,25 +170,23 @@ var sdk = new PlexAPI(
deviceName: "Linux"
);
var res = await sdk.Authentication.PostUsersSignInDataAsync(
clientID: "gcgzw5rz2xovp84b4vha3a40",
requestBody: new PostUsersSignInDataRequestBody() {
Login = "username@email.com",
Password = "password123",
VerificationCode = "123456",
}
);
PostUsersSignInDataRequestBody req = new PostUsersSignInDataRequestBody() {
Login = "username@email.com",
Password = "password123",
VerificationCode = "123456",
};
var res = await sdk.Authentication.PostUsersSignInDataAsync(req);
// handle response
```
### Parameters
| Parameter | 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 |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| 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. |
### Response

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

@@ -82,8 +82,8 @@ var sdk = new PlexAPI(
var res = await sdk.Hubs.GetLibraryHubsAsync(
sectionId: 6728.76D,
count: 9010.22D,
onlyTransient: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamOnlyTransient.Zero
count: 639.24D,
onlyTransient: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamOnlyTransient.One
);
// handle response

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

@@ -335,9 +335,9 @@ var sdk = new PlexAPI(
GetLibraryItemsRequest req = new GetLibraryItemsRequest() {
SectionKey = 9518,
Tag = LukeHagar.PlexAPI.SDK.Models.Requests.Tag.Edition,
Type = LukeHagar.PlexAPI.SDK.Models.Requests.Type.Two,
IncludeGuids = LukeHagar.PlexAPI.SDK.Models.Requests.IncludeGuids.One,
IncludeMeta = LukeHagar.PlexAPI.SDK.Models.Requests.IncludeMeta.One,
Type = LukeHagar.PlexAPI.SDK.Models.Requests.Type.Show,
IncludeGuids = LukeHagar.PlexAPI.SDK.Models.Requests.IncludeGuids.Enable,
IncludeMeta = LukeHagar.PlexAPI.SDK.Models.Requests.IncludeMeta.Enable,
XPlexContainerStart = 0,
XPlexContainerSize = 50,
};
@@ -455,7 +455,7 @@ var sdk = new PlexAPI(
var res = await sdk.Library.GetSearchLibraryAsync(
sectionKey: 9518,
type: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamType.Two
type: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamType.Show
);
// handle response
@@ -548,7 +548,7 @@ var sdk = new PlexAPI(
);
var res = await sdk.Library.GetMetadataChildrenAsync(
ratingKey: 1539.14D,
ratingKey: 1539.15D,
includeElements: "<value>"
);
@@ -597,7 +597,7 @@ var sdk = new PlexAPI(
);
var res = await sdk.Library.GetTopWatchedContentAsync(
type: LukeHagar.PlexAPI.SDK.Models.Requests.GetTopWatchedContentQueryParamType.Two,
type: LukeHagar.PlexAPI.SDK.Models.Requests.GetTopWatchedContentQueryParamType.Show,
includeGuids: 1
);

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

@@ -48,7 +48,7 @@ CreatePlaylistRequest req = new CreatePlaylistRequest() {
Title = "<value>",
Type = LukeHagar.PlexAPI.SDK.Models.Requests.CreatePlaylistQueryParamType.Photo,
Smart = LukeHagar.PlexAPI.SDK.Models.Requests.Smart.One,
Uri = "https://inborn-brochure.biz",
Uri = "https://hoarse-testing.info/",
};
var res = await sdk.Playlists.CreatePlaylistAsync(req);
@@ -236,7 +236,7 @@ var sdk = new PlexAPI(
);
var res = await sdk.Playlists.UpdatePlaylistAsync(
playlistID: 3915D,
playlistID: 3915.00D,
title: "<value>",
summary: "<value>"
);
@@ -291,7 +291,7 @@ var sdk = new PlexAPI(
var res = await sdk.Playlists.GetPlaylistContentsAsync(
playlistID: 5004.46D,
type: LukeHagar.PlexAPI.SDK.Models.Requests.GetPlaylistContentsQueryParamType.Two
type: LukeHagar.PlexAPI.SDK.Models.Requests.GetPlaylistContentsQueryParamType.Show
);
// handle response
@@ -385,7 +385,7 @@ var sdk = new PlexAPI(
);
var res = await sdk.Playlists.AddPlaylistContentsAsync(
playlistID: 8502.01D,
playlistID: 8502.00D,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123D
);
@@ -437,7 +437,8 @@ var sdk = new PlexAPI(
var res = await sdk.Playlists.UploadPlaylistAsync(
path: "/home/barkley/playlist.m3u",
force: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamForce.Zero
force: LukeHagar.PlexAPI.SDK.Models.Requests.QueryParamForce.Zero,
sectionID: 1
);
// handle response
@@ -449,6 +450,7 @@ var res = await sdk.Playlists.UploadPlaylistAsync(
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `SectionID` | *long* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
### Response

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

@@ -202,10 +202,9 @@ var sdk = new PlexAPI(
);
var res = await sdk.Plex.GetServerResourcesAsync(
clientID: "gcgzw5rz2xovp84b4vha3a40",
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.One,
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.One,
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.One
includeHttps: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeHttps.Enable,
includeRelay: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeRelay.Enable,
includeIPv6: LukeHagar.PlexAPI.SDK.Models.Requests.IncludeIPv6.Enable
);
// handle response
@@ -213,13 +212,12 @@ var res = await sdk.Plex.GetServerResourcesAsync(
### Parameters
| Parameter | 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 |
| `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 |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
@@ -298,21 +296,17 @@ var sdk = new PlexAPI(
deviceName: "Linux"
);
var res = await sdk.Plex.GetTokenByPinIdAsync(
pinID: 408895,
clientID: "gcgzw5rz2xovp84b4vha3a40"
);
var res = await sdk.Plex.GetTokenByPinIdAsync(pinID: 408895);
// handle response
```
### Parameters
| Parameter | 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 |
| `serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| 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. |
### Response

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

@@ -45,8 +45,8 @@ var sdk = new PlexAPI(
);
var res = await sdk.Search.PerformSearchAsync(
query: "arnold",
sectionId: 9372.7D,
query: "dylan",
sectionId: 5838.67D,
limit: 5D
);
@@ -100,7 +100,7 @@ var sdk = new PlexAPI(
var res = await sdk.Search.PerformVoiceSearchAsync(
query: "dead+poop",
sectionId: 4094.8D,
sectionId: 4094.80D,
limit: 5D
);

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

@@ -263,9 +263,9 @@ GetResizedPhotoRequest req = new GetResizedPhotoRequest() {
Width = 110D,
Height = 165D,
Opacity = 100,
Blur = 4000D,
MinSize = LukeHagar.PlexAPI.SDK.Models.Requests.MinSize.Zero,
Upscale = LukeHagar.PlexAPI.SDK.Models.Requests.Upscale.Zero,
Blur = 0D,
MinSize = LukeHagar.PlexAPI.SDK.Models.Requests.MinSize.One,
Upscale = LukeHagar.PlexAPI.SDK.Models.Requests.Upscale.One,
Url = "/library/metadata/49564/thumb/1654258204",
};