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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0

Browse Source
This commit is contained in:
speakeasybot
2025-02-07 00:09:14 +00:00
parent 05d9189c07
commit d0612f0118
60 changed files with 1185 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/models/operations/alllibraries.md Normal file
View File

@@ -0,0 +1,11 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/allowcameraupload.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/allowchannels.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowChannels
Indicates if the user has access to channels.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/allowsubtitleadmin.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/allowsync.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/allowtuners.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

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

@@ -36,4 +36,4 @@
| `country` | T::Array<[::PlexRubySDK::Operations::GetTopWatchedContentCountry](../../models/operations/gettopwatchedcontentcountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | T::Array<[::PlexRubySDK::Operations::GetTopWatchedContentGuids](../../models/operations/gettopwatchedcontentguids.md)> | :heavy_minus_sign: | N/A | |
| `role` | T::Array<[::PlexRubySDK::Operations::GetTopWatchedContentRole](../../models/operations/gettopwatchedcontentrole.md)> | :heavy_minus_sign: | N/A | |
| `user` | T::Array<[::PlexRubySDK::Operations::User](../../models/operations/user.md)> | :heavy_minus_sign: | N/A | |
| `user` | T::Array<[::PlexRubySDK::Operations::GetTopWatchedContentUser](../../models/operations/gettopwatchedcontentuser.md)> | :heavy_minus_sign: | N/A | |

8
docs/models/operations/gettopwatchedcontentuser.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTopWatchedContentUser
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |

10
docs/models/operations/getusersbadrequest.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `errors` | T::Array<[::PlexRubySDK::Operations::GetUsersErrors](../../models/operations/getuserserrors.md)> | :heavy_minus_sign: | N/A |

10
docs/models/operations/getuserserrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 400 |

15
docs/models/operations/getusersmediacontainer.md Normal file
View File

@@ -0,0 +1,15 @@
# GetUsersMediaContainer
Container holding user and server details.
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `friendly_name` | *::String* | :heavy_check_mark: | The friendly name of the Plex instance. | myPlex |
| `identifier` | *::String* | :heavy_check_mark: | N/A | com.plexapp.plugins.myplex |
| `machine_identifier` | *::String* | :heavy_check_mark: | Unique Machine identifier of the Plex server. | 3dff4c4da3b1229a649aa574a9e2b419a684a20e |
| `total_size` | *::Integer* | :heavy_check_mark: | Total number of users. | 30 |
| `size` | *::Integer* | :heavy_check_mark: | Number of users in the current response. | 30 |
| `user` | T::Array<[::PlexRubySDK::Operations::User](../../models/operations/user.md)> | :heavy_check_mark: | List of users with access to the Plex server. | |

20
docs/models/operations/getusersrequest.md Normal file
View File

@@ -0,0 +1,20 @@
# GetUsersRequest
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `client_id` | *::String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `client_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `device_nickname` | *T.nilable(::String)* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `device_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.) | Chrome |
| `device_screen_resolution` | *T.nilable(::String)* | :heavy_minus_sign: | The resolution of the device the client application is running on. This is used to track the client application and its usage. (1487x1165,2560x1440) | 1487x1165,2560x1440 |
| `client_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *T.nilable(::String)* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `client_features` | *T.nilable(::String)* | :heavy_minus_sign: | The features of the client application. This is used to track the client application and its usage. (external-media,indirect-media,hub-style-list) | external-media,indirect-media,hub-style-list |
| `model` | *T.nilable(::String)* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `x_plex_session_id` | *T.nilable(::String)* | :heavy_minus_sign: | The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca) | 97e136ef-4ddd-4ff3-89a7-a5820c96c2ca |
| `x_plex_language` | *T.nilable(::String)* | :heavy_minus_sign: | The language of the client application. | en |
| `platform_version` | *T.nilable(::String)* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `x_plex_token` | *::String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

13
docs/models/operations/getusersresponse.md Normal file
View File

@@ -0,0 +1,13 @@
# GetUsersResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `body` | *T.nilable(::String)* | :heavy_minus_sign: | N/A |
| `bad_request` | [T.nilable(::PlexRubySDK::Operations::GetUsersBadRequest)](../../models/operations/getusersbadrequest.md) | :heavy_minus_sign: | Bad Request - A parameter was not specified, or was specified incorrectly. |
| `unauthorized` | [T.nilable(::PlexRubySDK::Operations::GetUsersUnauthorized)](../../models/operations/getusersunauthorized.md) | :heavy_minus_sign: | Unauthorized - Returned if the X-Plex-Token is missing from the header or query. |

10
docs/models/operations/getusersresponsebody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersResponseBody
Successful response with media container data in XML
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `media_container` | [T.nilable(::PlexRubySDK::Operations::GetUsersMediaContainer)](../../models/operations/getusersmediacontainer.md) | :heavy_minus_sign: | Container holding user and server details. |

16
docs/models/operations/getusersserver.md Normal file
View File

@@ -0,0 +1,16 @@
# GetUsersServer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `id` | *::Integer* | :heavy_check_mark: | Unique ID of the server of the connected user | 907759180 |
| `server_id` | *::Integer* | :heavy_check_mark: | ID of the actual Plex server. | 9999999 |
| `machine_identifier` | *::String* | :heavy_check_mark: | Machine identifier of the Plex server. | fbb8aa6be6e0c997c6268bc2b4431c8807f70a3 |
| `name` | *::String* | :heavy_check_mark: | Name of the Plex server of the connected user. | ConnectedUserFlix |
| `last_seen_at` | *::Integer* | :heavy_check_mark: | N/A | 1556281940 |
| `num_libraries` | *::Integer* | :heavy_check_mark: | Number of libraries in the server this user has access to. | 16 |
| `all_libraries` | [::PlexRubySDK::Operations::AllLibraries](../../models/operations/alllibraries.md) | :heavy_check_mark: | N/A | 1 |
| `owned` | [::PlexRubySDK::Operations::Owned](../../models/operations/owned.md) | :heavy_check_mark: | N/A | 1 |
| `pending` | [::PlexRubySDK::Operations::Pending](../../models/operations/pending.md) | :heavy_check_mark: | N/A | 1 |

10
docs/models/operations/getusersunauthorized.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `errors` | T::Array<[::PlexRubySDK::Operations::GetUsersUsersErrors](../../models/operations/getusersuserserrors.md)> | :heavy_minus_sign: | N/A |

10
docs/models/operations/getusersuserserrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersUsersErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 401 |

11
docs/models/operations/home.md Normal file
View File

@@ -0,0 +1,11 @@
# Home
Indicates if the user is part of a home group.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/owned.md Normal file
View File

@@ -0,0 +1,11 @@
# Owned
Indicates if the user owns the server.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/pending.md Normal file
View File

@@ -0,0 +1,11 @@
# Pending
Indicates if the server is pending approval.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/protected.md Normal file
View File

@@ -0,0 +1,11 @@
# Protected
Indicates whether the account is protected.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

11
docs/models/operations/restricted.md Normal file
View File

@@ -0,0 +1,11 @@
# Restricted
Indicates if the user has restricted access.
## Values
| Name | Value |
| --------- | --------- |
| `DISABLE` | 0 |
| `ENABLE` | 1 |

25
docs/models/operations/user.md
View File

@@ -3,6 +3,25 @@
## Fields
| Field | Type | Required | Description | Example |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `id` | *T.nilable(::Integer)* | :heavy_minus_sign: | N/A | 220 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `id` | *::Integer* | :heavy_check_mark: | User's unique ID. | 22526914 |
| `title` | *::String* | :heavy_check_mark: | User's display name. | Plex User |
| `username` | *::String* | :heavy_check_mark: | User's username. | zgfuc7krcqfimrmb9lsl5j |
| `email` | *::String* | :heavy_check_mark: | User's email address. | zgfuc7krcqfimrmb9lsl5j@protonmail.com |
| `recommendations_playlist_id` | *T.nilable(::String)* | :heavy_minus_sign: | ID of the user's recommendation playlist. | |
| `thumb` | *::String* | :heavy_check_mark: | URL to the user's avatar image. | https://plex.tv/users/3346028014e93acd/avatar?c=1731605021 |
| `protected` | [::PlexRubySDK::Operations::Protected](../../models/operations/protected.md) | :heavy_check_mark: | N/A | 1 |
| `home` | [::PlexRubySDK::Operations::Home](../../models/operations/home.md) | :heavy_check_mark: | N/A | 1 |
| `allow_tuners` | [::PlexRubySDK::Operations::AllowTuners](../../models/operations/allowtuners.md) | :heavy_check_mark: | N/A | 1 |
| `allow_sync` | [::PlexRubySDK::Operations::AllowSync](../../models/operations/allowsync.md) | :heavy_check_mark: | N/A | 1 |
| `allow_camera_upload` | [::PlexRubySDK::Operations::AllowCameraUpload](../../models/operations/allowcameraupload.md) | :heavy_check_mark: | N/A | 1 |
| `allow_channels` | [::PlexRubySDK::Operations::AllowChannels](../../models/operations/allowchannels.md) | :heavy_check_mark: | N/A | 1 |
| `allow_subtitle_admin` | [::PlexRubySDK::Operations::AllowSubtitleAdmin](../../models/operations/allowsubtitleadmin.md) | :heavy_check_mark: | N/A | 1 |
| `filter_all` | *T.nilable(::String)* | :heavy_minus_sign: | Filters applied for all content. | |
| `filter_movies` | *T.nilable(::String)* | :heavy_minus_sign: | Filters applied for movies. | |
| `filter_music` | *T.nilable(::String)* | :heavy_minus_sign: | Filters applied for music. | |
| `filter_photos` | *T.nilable(::String)* | :heavy_minus_sign: | Filters applied for photos. | |
| `filter_television` | *T.nilable(::String)* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [::PlexRubySDK::Operations::Restricted](../../models/operations/restricted.md) | :heavy_check_mark: | N/A | 1 |
| `server` | T::Array<[::PlexRubySDK::Operations::GetUsersServer](../../models/operations/getusersserver.md)> | :heavy_check_mark: | List of servers owned by the user. | |

57
docs/sdks/users/README.md Normal file
View File

@@ -0,0 +1,57 @@
# Users
(*users*)
## Overview
### Available Operations
* [get_users](#get_users) - Get list of all connected users
## get_users
Get list of all users that are friends and have library access with the provided Plex authentication token
### Example Usage
```ruby
require 'plex_ruby_sdk'
s = ::PlexRubySDK::PlexAPI.new
req = ::PlexRubySDK::Operations::GetUsersRequest.new(
client_id: "3381b62b-9ab7-4e37-827b-203e9809eb58",
client_name: "Plex for Roku",
device_nickname: "Roku 3",
device_name: "Chrome",
device_screen_resolution: "1487x1165,2560x1440",
client_version: "2.4.1",
platform: "Roku",
client_features: "external-media,indirect-media,hub-style-list",
model: "4200X",
x_plex_session_id: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
x_plex_language: "en",
platform_version: "4.3 build 1057",
x_plex_token: "CV5xoxjTpFKUzBTShsaf",
)
res = s.users.get_users(req)
if ! res.body.nil?
# handle response
end
```
### Parameters
| Parameter | Type | Required | Description |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `request` | [::PlexRubySDK::Operations::GetUsersRequest](../../models/operations/getusersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `server_url` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[T.nilable(::PlexRubySDK::Operations::GetUsersResponse)](../../models/operations/getusersresponse.md)**