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