LukeParke/plexjava
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjava.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1

Browse Source
This commit is contained in:
speakeasybot
2025-02-06 00:27:45 +00:00
parent f33408b177
commit a4a2130978
59 changed files with 4903 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/models/errors/GetUsersBadRequest.md Normal file
View File

@@ -0,0 +1,11 @@
# GetUsersBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetUsersErrors](../../models/errors/GetUsersErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/models/errors/GetUsersErrors.md Normal file
View File

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

11
docs/models/errors/GetUsersUnauthorized.md Normal file
View File

@@ -0,0 +1,11 @@
# GetUsersUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `errors` | List\<[GetUsersUsersErrors](../../models/errors/GetUsersUsersErrors.md)> | :heavy_minus_sign: | N/A |
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/models/errors/GetUsersUsersErrors.md Normal file
View File

@@ -0,0 +1,10 @@
# GetUsersUsersErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |

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` | List\<[GetTopWatchedContentCountry](../../models/operations/GetTopWatchedContentCountry.md)> | :heavy_minus_sign: | N/A | |
| `guids` | List\<[GetTopWatchedContentGuids](../../models/operations/GetTopWatchedContentGuids.md)> | :heavy_minus_sign: | N/A | |
| `role` | List\<[GetTopWatchedContentRole](../../models/operations/GetTopWatchedContentRole.md)> | :heavy_minus_sign: | N/A | |
| `user` | List\<[User](../../models/operations/User.md)> | :heavy_minus_sign: | N/A | |
| `user` | List\<[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` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 220 |

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 |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `friendlyName` | *String* | :heavy_check_mark: | The friendly name of the Plex instance. | myPlex |
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.myplex |
| `machineIdentifier` | *String* | :heavy_check_mark: | Unique Machine identifier of the Plex server. | 3dff4c4da3b1229a649aa574a9e2b419a684a20e |
| `totalSize` | *long* | :heavy_check_mark: | Total number of users. | 30 |
| `size` | *long* | :heavy_check_mark: | Number of users in the current response. | 30 |
| `user` | List\<[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 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientID` | *String* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `clientName` | *Optional\<String>* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
| `deviceNickname` | *Optional\<String>* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
| `deviceName` | *Optional\<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 |
| `deviceScreenResolution` | *Optional\<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 |
| `clientVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
| `platform` | *Optional\<String>* | :heavy_minus_sign: | The platform of the client application. | Roku |
| `clientFeatures` | *Optional\<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` | *Optional\<String>* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
| `xPlexSessionId` | *Optional\<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 |
| `xPlexLanguage` | *Optional\<String>* | :heavy_minus_sign: | The language of the client application. | en |
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
| `xPlexToken` | *String* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

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

@@ -0,0 +1,11 @@
# GetUsersResponse
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `body` | *Optional\<byte[]>* | :heavy_minus_sign: | N/A |

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 |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `mediaContainer` | [Optional\<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` | *long* | :heavy_check_mark: | Unique ID of the server of the connected user | 907759180 |
| `serverId` | *long* | :heavy_check_mark: | ID of the actual Plex server. | 9999999 |
| `machineIdentifier` | *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 |
| `lastSeenAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `numLibraries` | *long* | :heavy_check_mark: | Number of libraries in the server this user has access to. | 16 |
| `allLibraries` | [Optional\<AllLibraries>](../../models/operations/AllLibraries.md) | :heavy_minus_sign: | N/A | 1 |
| `owned` | [Optional\<Owned>](../../models/operations/Owned.md) | :heavy_minus_sign: | N/A | 1 |
| `pending` | [Optional\<Pending>](../../models/operations/Pending.md) | :heavy_minus_sign: | N/A | 1 |

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` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 220 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `id` | *long* | :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 |
| `recommendationsPlaylistId` | *JsonNullable\<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_` | [Optional\<Protected>](../../models/operations/Protected.md) | :heavy_minus_sign: | N/A | 1 |
| `home` | [Optional\<Home>](../../models/operations/Home.md) | :heavy_minus_sign: | N/A | 1 |
| `allowTuners` | [Optional\<AllowTuners>](../../models/operations/AllowTuners.md) | :heavy_minus_sign: | N/A | 1 |
| `allowSync` | [Optional\<AllowSync>](../../models/operations/AllowSync.md) | :heavy_minus_sign: | N/A | 1 |
| `allowCameraUpload` | [Optional\<AllowCameraUpload>](../../models/operations/AllowCameraUpload.md) | :heavy_minus_sign: | N/A | 1 |
| `allowChannels` | [Optional\<AllowChannels>](../../models/operations/AllowChannels.md) | :heavy_minus_sign: | N/A | 1 |
| `allowSubtitleAdmin` | [Optional\<AllowSubtitleAdmin>](../../models/operations/AllowSubtitleAdmin.md) | :heavy_minus_sign: | N/A | 1 |
| `filterAll` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for all content. | |
| `filterMovies` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for movies. | |
| `filterMusic` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for music. | |
| `filterPhotos` | *JsonNullable\<String>* | :heavy_minus_sign: | Filters applied for photos. | |
| `filterTelevision` | *Optional\<String>* | :heavy_minus_sign: | Filters applied for television. | |
| `restricted` | [Optional\<Restricted>](../../models/operations/Restricted.md) | :heavy_minus_sign: | N/A | 1 |
| `server` | List\<[GetUsersServer](../../models/operations/GetUsersServer.md)> | :heavy_check_mark: | List of servers owned by the user. | |

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

@@ -0,0 +1,77 @@
# Users
(*users()*)
## Overview
### Available Operations
* [getUsers](#getusers) - Get list of all connected users
## getUsers
Get list of all users that are friends and have library access with the provided Plex authentication token
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetUsersBadRequest;
import dev.plexapi.sdk.models.errors.GetUsersUnauthorized;
import dev.plexapi.sdk.models.operations.GetUsersRequest;
import dev.plexapi.sdk.models.operations.GetUsersResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetUsersBadRequest, GetUsersUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.build();
GetUsersRequest req = GetUsersRequest.builder()
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
.clientName("Plex for Roku")
.deviceNickname("Roku 3")
.deviceName("Chrome")
.deviceScreenResolution("1487x1165,2560x1440")
.clientVersion("2.4.1")
.platform("Roku")
.clientFeatures("external-media,indirect-media,hub-style-list")
.model("4200X")
.xPlexSessionId("97e136ef-4ddd-4ff3-89a7-a5820c96c2ca")
.xPlexLanguage("en")
.platformVersion("4.3 build 1057")
.build();
GetUsersResponse res = sdk.users().getUsers()
.request(req)
.call();
if (res.body().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `request` | [GetUsersRequest](../../models/operations/GetUsersRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetUsersResponse](../../models/operations/GetUsersResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| models/errors/GetUsersBadRequest | 400 | application/json |
| models/errors/GetUsersUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |