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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5

Browse Source
This commit is contained in:
speakeasybot
2024-09-28 00:21:51 +00:00
parent d16abdad70
commit affe5d5a8c
38 changed files with 297 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/Models/Requests/Connections.md
View File

@@ -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 | |

11
docs/Models/Requests/GetTokenByPinIdRequest.md
View File

@@ -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 |

2
docs/Models/Requests/GetTokenDetailsUserPlexAccount.md
View File

@@ -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 | |

2
docs/Models/Requests/MailingListStatus.md
View File

@@ -1,6 +1,6 @@
# MailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

2
docs/Models/Requests/PostUsersSignInDataMailingListStatus.md
View File

@@ -1,6 +1,6 @@
# PostUsersSignInDataMailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

2
docs/Models/Requests/PostUsersSignInDataUserPlexAccount.md
View File

@@ -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 | |

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

@@ -296,17 +296,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

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

@@ -2,4 +2,27 @@
## Overview
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
# Plex Media Server OpenAPI Specification
An Open Source OpenAPI Specification for Plex Media Server
Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## SDKs
The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the respective repository.
| 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) | -