LukeParke/plexpy
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexpy.git synced 2025-12-06 04:20:52 +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:02:48 +00:00
parent 6a7d52838f
commit 9aa225f681
46 changed files with 5898 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/models/operations/connections.md
View File

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
| `address` | *str* | :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` | *str* | :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 |
| `i_pv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) | http |
| `address` | *str* | :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` | *str* | :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 | |
| `i_pv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 | |

12
docs/models/operations/gettokenbypinidglobals.md Normal file
View File

@@ -0,0 +1,12 @@
# GetTokenByPinIDGlobals
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *Optional[str]* | :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 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome |

11
docs/models/operations/gettokenbypinidrequest.md
View File

@@ -3,6 +3,11 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `client_id` | *Optional[str]* | :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 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome |

2
docs/models/operations/gettokendetailsuserplexaccount.md
View File

@@ -19,7 +19,7 @@ Logged in user details
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_status` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `mailing_list_status` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |

2
docs/models/operations/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/operations/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/operations/postuserssignindatauserplexaccount.md
View File

@@ -19,7 +19,7 @@ Returns the user account data with a valid auth token
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
| `joined_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `locale` | *Nullable[str]* | :heavy_check_mark: | The account locale | |
| `mailing_list_status` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `mailing_list_status` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `max_home_size` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| `profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |
| `remember_expires_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |

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

@@ -310,7 +310,9 @@ s = PlexAPI(
device_name="Linux",
)
res = s.plex.get_token_by_pin_id(pin_id=408895)
res = s.plex.get_token_by_pin_id(request={
"pin_id": 408895,
})
if res.auth_pin_container is not None:
# handle response
@@ -320,11 +322,11 @@ if res.auth_pin_container is not None:
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `request` | [operations.GetTokenByPinIDRequest](../../models/operations/gettokenbypinidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
| `server_url` | *Optional[str]* | :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) | -