mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-10 12:47:45 +00:00
19 lines
5.3 KiB
Markdown
19 lines
5.3 KiB
Markdown
# Friend
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
| `email` | *str* | :heavy_check_mark: | The account email address | username@email.com |
|
|
| `friendly_name` | *Nullable[str]* | :heavy_check_mark: | The account full name | exampleUser |
|
|
| `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
|
|
| `id` | *int* | :heavy_check_mark: | The Plex account ID | |
|
|
| `shared_servers` | List[[operations.SharedServers](../../models/operations/sharedservers.md)] | :heavy_check_mark: | N/A | |
|
|
| `shared_sources` | List[[operations.SharedSources](../../models/operations/sharedsources.md)] | :heavy_check_mark: | N/A | |
|
|
| `status` | [operations.Status](../../models/operations/status.md) | :heavy_check_mark: | Current friend request status | accepted |
|
|
| `thumb` | *str* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578 |
|
|
| `title` | *str* | :heavy_check_mark: | The title of the account (username or friendly name) | username123 |
|
|
| `username` | *str* | :heavy_check_mark: | The account username | username123 |
|
|
| `uuid` | *str* | :heavy_check_mark: | The account Universally Unique Identifier (UUID) | 7d1916e0d8f6e76b |
|
|
| `restricted` | *Optional[bool]* | :heavy_minus_sign: | If the account is a Plex Home managed user | | |