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

## Java SDK Changes Detected:

Browse Source 
* `plex-api.libraryPlaylists.addPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.clearPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.moveCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.deleteCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.addCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.butler.stopTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.butler.startTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicPath()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getItemDecision()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getAllHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getContinueWatching()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPromotedHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getMetadataHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPostplayHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getRelatedHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getSectionHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAllLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.listContent()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.searchHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAlbums()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryItems()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.ingestTransientItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryMatches()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getMetadataItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getSections()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.addSection()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getTags()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
* `plex-api.content.getCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getAllItemLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.status.listSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.movePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getExtras()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.deletePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.unshuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listMatches()`: 
  *  `request.manual` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.shuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getRelatedItems()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.resetPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getItemTree()`:  `response.mediacontainer.metadataItem.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.clearPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.addToPlayQueue()`: 
  *  `request.next` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCommon()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getPerson()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listPersonMedia()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.getPlayQueue()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryDetails()`: 
  *  `request.includeDetails` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.movePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.autocomplete()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCollections()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`:  `response.mediacontainer.metadata` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.deletePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.voiceSearchHubs()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.createPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.listPlaylists()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.collections.createCollection()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.tuneChannel()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getLiveTvSession()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.makeDecision()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getAllSubscriptions()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.createSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getScheduledRecordings()`:  `response.mediacontainer.mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getTemplate()`:  `response.mediacontainer.subscriptionTemplate.[].mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getSubscription()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.editSubscriptionPreferences()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.reorderSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.library.addSubtitles()`:  `request` **Changed**
* `plex-api.libraryPlaylists.uploadPlaylist()`: 
  *  `request.force` **Changed**
* `plex-api.transcoder.transcodeSubtitles()`:  `request` **Changed**
* `plex-api.transcoder.startTranscodeSession()`:  `request` **Changed**
* `plex-api.library.getMediaPart()`: 
  *  `request.download` **Changed**
* `plex-api.library.detectIntros()`: 
  *  `request.force` **Changed**
* `plex-api.library.getSectionImage()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.library.deleteMediaItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.library.refreshItemsMetadata()`: 
  *  `request.markUpdated` **Changed**
* `plex-api.authentication.postUsersSignInData()`: **Added**
* `plex-api.authentication.getTokenDetails()`: **Added**
* `plex-api.library.detectCredits()`:  `request` **Changed**
* `plex-api.library.setStreamSelection()`: 
  *  `request.allParts` **Changed**
* `plex-api.library.updateItems()`: 
  *  `request.field.locked` **Changed**
* `plex-api.playQueue.createPlayQueue()`:  `request` **Changed**
* `plex-api.library.deleteLibrarySection()`: 
  *  `request.async` **Changed**
* `plex-api.library.getAugmentationStatus()`: 
  *  `request.wait` **Changed**
* `plex-api.transcoder.transcodeImage()`:  `request` **Changed**
* `plex-api.devices.modifyDevice()`: 
  *  `request.enabled` **Changed**
* `plex-api.library.detectVoiceActivity()`:  `request` **Changed**
* `plex-api.library.getStream()`: 
  *  `request.autoAdjustSubtitle` **Changed**
* `plex-api.library.startBifGeneration()`: 
  *  `request.force` **Changed**
* `plex-api.library.getFirstCharacters()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.ultraBlur.getImage()`: 
  *  `request.noise` **Changed**
* `plex-api.library.generateThumbs()`: 
  *  `request.force` **Changed**
* `plex-api.updater.applyUpdates()`:  `request` **Changed**
* `plex-api.updater.checkUpdates()`: 
  *  `request.download` **Changed**
* `plex-api.library.deleteMetadataItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.library.optimizeDatabase()`: 
  *  `request.async` **Changed**
* `plex-api.library.refreshSection()`: 
  *  `request.force` **Changed**
* `plex-api.hubs.updateHubVisibility()`:  `request` **Changed**
* `plex-api.hubs.createCustomHub()`:  `request` **Changed**
* `plex-api.downloadQueue.addDownloadQueueItems()`:  `request` **Changed**
* `plex-api.timeline.report()`:  `request` **Changed**
* `plex-api.general.getSourceConnectionInformation()`: 
  *  `request.refresh` **Changed**
* `plex-api.plex.getServerResources()`: **Added**
* `plex-api.users.getUsers()`: **Added**
This commit is contained in:
speakeasybot
2025-12-01 00:42:04 +00:00
parent 66d8250cb0
commit 1e29008284
344 changed files with 42375 additions and 6863 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
docs/sdks/authentication/README.md Normal file
View File

@@ -0,0 +1,152 @@
# Authentication
(*authentication()*)
## Overview
### Available Operations
* [getTokenDetails](#gettokendetails) - Get Token Details
* [postUsersSignInData](#postuserssignindata) - Get User Sign In Data
## getTokenDetails
Get the User data from the provided X-Plex-Token
### Example Usage
<!-- UsageSnippet language="java" operationID="getTokenDetails" method="get" path="/user" -->
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetTokenDetailsBadRequest;
import dev.plexapi.sdk.models.errors.GetTokenDetailsUnauthorized;
import dev.plexapi.sdk.models.operations.GetTokenDetailsRequest;
import dev.plexapi.sdk.models.operations.GetTokenDetailsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetTokenDetailsBadRequest, GetTokenDetailsUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("abc123")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetTokenDetailsRequest req = GetTokenDetailsRequest.builder()
.build();
GetTokenDetailsResponse res = sdk.authentication().getTokenDetails()
.request(req)
.call();
if (res.userPlexAccount().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `request` | [GetTokenDetailsRequest](../../models/operations/GetTokenDetailsRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetTokenDetailsResponse](../../models/operations/GetTokenDetailsResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| models/errors/GetTokenDetailsBadRequest | 400 | application/json |
| models/errors/GetTokenDetailsUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |
## postUsersSignInData
Sign in user with username and password and return user data with Plex authentication token
### Example Usage
<!-- UsageSnippet language="java" operationID="post-users-sign-in-data" method="post" path="/users/signin" -->
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.PostUsersSignInDataBadRequest;
import dev.plexapi.sdk.models.errors.PostUsersSignInDataUnauthorized;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws PostUsersSignInDataBadRequest, PostUsersSignInDataUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("3381b62b-9ab7-4e37-827b-203e9809eb58")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Living Room TV")
.marketplace("googlePlay")
.build();
PostUsersSignInDataRequest req = PostUsersSignInDataRequest.builder()
.requestBody(PostUsersSignInDataRequestBody.builder()
.login("username@email.com")
.password("password123")
.verificationCode("123456")
.build())
.build();
PostUsersSignInDataResponse res = sdk.authentication().postUsersSignInData()
.request(req)
.call();
if (res.userPlexAccount().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `request` | [PostUsersSignInDataRequest](../../models/operations/PostUsersSignInDataRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[PostUsersSignInDataResponse](../../models/operations/PostUsersSignInDataResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| models/errors/PostUsersSignInDataBadRequest | 400 | application/json |
| models/errors/PostUsersSignInDataUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |

8
docs/sdks/butler/README.md
View File

@@ -149,7 +149,7 @@ This endpoint will stop a currently running task by name, or remove it from the
### Example Usage
<!-- UsageSnippet language="java" operationID="stopTask" method="delete" path="/butler/{task}" -->
<!-- UsageSnippet language="java" operationID="stopTask" method="delete" path="/butler/{butlerTask}" -->
```java
package hello.world;
@@ -178,7 +178,7 @@ public class Application {
.build();
StopTaskRequest req = StopTaskRequest.builder()
.task(Task.CLEAN_OLD_BUNDLES)
.butlerTask(ButlerTask.CLEAN_OLD_BUNDLES)
.build();
StopTaskResponse res = sdk.butler().stopTask()
@@ -213,7 +213,7 @@ This endpoint will attempt to start a specific Butler task by name.
### Example Usage
<!-- UsageSnippet language="java" operationID="startTask" method="post" path="/butler/{task}" -->
<!-- UsageSnippet language="java" operationID="startTask" method="post" path="/butler/{butlerTask}" -->
```java
package hello.world;
@@ -242,7 +242,7 @@ public class Application {
.build();
StartTaskRequest req = StartTaskRequest.builder()
.task(PathParamTask.REFRESH_LOCAL_MEDIA)
.butlerTask(PathParamButlerTask.REFRESH_LOCAL_MEDIA)
.build();
StartTaskResponse res = sdk.butler().startTask()

2
docs/sdks/collections/README.md
View File

@@ -23,6 +23,7 @@ import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.CreateCollectionRequest;
import dev.plexapi.sdk.models.operations.CreateCollectionResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.MediaType;
import java.lang.Exception;
public class Application {
@@ -46,6 +47,7 @@ public class Application {
CreateCollectionRequest req = CreateCollectionRequest.builder()
.sectionId("<id>")
.type(MediaType.TvShow)
.build();
CreateCollectionResponse res = sdk.collections().createCollection()

25
docs/sdks/content/README.md
View File

@@ -126,14 +126,14 @@ public class Application {
GetMetadataItemRequest req = GetMetadataItemRequest.builder()
.ids(List.of())
.asyncCheckFiles(BoolInt.ONE)
.asyncRefreshLocalMediaAgent(BoolInt.ONE)
.asyncRefreshAnalysis(BoolInt.ONE)
.checkFiles(BoolInt.ONE)
.skipRefresh(BoolInt.ONE)
.checkFileAvailability(BoolInt.ONE)
.asyncAugmentMetadata(BoolInt.ONE)
.augmentCount(BoolInt.ONE)
.asyncCheckFiles(BoolInt.True)
.asyncRefreshLocalMediaAgent(BoolInt.True)
.asyncRefreshAnalysis(BoolInt.True)
.checkFiles(BoolInt.True)
.skipRefresh(BoolInt.True)
.checkFileAvailability(BoolInt.True)
.asyncAugmentMetadata(BoolInt.True)
.augmentCount(BoolInt.True)
.build();
GetMetadataItemResponse res = sdk.content().getMetadataItem()
@@ -242,7 +242,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ListContentRequest;
import dev.plexapi.sdk.models.operations.ListContentResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -266,6 +266,13 @@ public class Application {
ListContentRequest req = ListContentRequest.builder()
.sectionId("<id>")
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.includeMeta(BoolInt.True)
.includeGuids(BoolInt.True)
.build();
ListContentResponse res = sdk.content().listContent()

2
docs/sdks/devices/README.md
View File

@@ -441,7 +441,7 @@ public class Application {
ModifyDeviceRequest req = ModifyDeviceRequest.builder()
.deviceId(879135L)
.enabled(BoolInt.ONE)
.enabled(BoolInt.True)
.build();
ModifyDeviceResponse res = sdk.devices().modifyDevice()

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

@@ -178,13 +178,13 @@ public class Application {
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.autoAdjustQuality(BoolInt.True)
.autoAdjustSubtitle(BoolInt.True)
.directPlay(BoolInt.True)
.directStream(BoolInt.True)
.directStreamAudio(BoolInt.True)
.disableResolutionRotation(BoolInt.True)
.hasMDE(BoolInt.True)
.location(Location.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)

2
docs/sdks/general/README.md
View File

@@ -156,7 +156,7 @@ public class Application {
GetSourceConnectionInformationRequest req = GetSourceConnectionInformationRequest.builder()
.source("server://client-identifier")
.refresh(BoolInt.ONE)
.refresh(BoolInt.True)
.build();
GetSourceConnectionInformationResponse res = sdk.general().getSourceConnectionInformation()

22
docs/sdks/hubs/README.md
View File

@@ -59,7 +59,7 @@ public class Application {
.build();
GetAllHubsRequest req = GetAllHubsRequest.builder()
.onlyTransient(BoolInt.ONE)
.onlyTransient(BoolInt.True)
.build();
GetAllHubsResponse res = sdk.hubs().getAllHubs()
@@ -327,7 +327,7 @@ public class Application {
GetMetadataHubsRequest req = GetMetadataHubsRequest.builder()
.metadataId(605482L)
.onlyTransient(BoolInt.ONE)
.onlyTransient(BoolInt.True)
.build();
GetMetadataHubsResponse res = sdk.hubs().getMetadataHubs()
@@ -395,7 +395,7 @@ public class Application {
GetPostplayHubsRequest req = GetPostplayHubsRequest.builder()
.metadataId(441419L)
.onlyTransient(BoolInt.ONE)
.onlyTransient(BoolInt.True)
.build();
GetPostplayHubsResponse res = sdk.hubs().getPostplayHubs()
@@ -463,7 +463,7 @@ public class Application {
GetRelatedHubsRequest req = GetRelatedHubsRequest.builder()
.metadataId(8858L)
.onlyTransient(BoolInt.ONE)
.onlyTransient(BoolInt.True)
.build();
GetRelatedHubsResponse res = sdk.hubs().getRelatedHubs()
@@ -531,7 +531,7 @@ public class Application {
GetSectionHubsRequest req = GetSectionHubsRequest.builder()
.sectionId(336924L)
.onlyTransient(BoolInt.ONE)
.onlyTransient(BoolInt.True)
.build();
GetSectionHubsResponse res = sdk.hubs().getSectionHubs()
@@ -730,9 +730,9 @@ public class Application {
CreateCustomHubRequest req = CreateCustomHubRequest.builder()
.sectionId(869922L)
.metadataItemId(703843L)
.promotedToRecommended(BoolInt.ONE)
.promotedToOwnHome(BoolInt.ONE)
.promotedToSharedHome(BoolInt.ONE)
.promotedToRecommended(BoolInt.True)
.promotedToOwnHome(BoolInt.True)
.promotedToSharedHome(BoolInt.True)
.build();
CreateCustomHubResponse res = sdk.hubs().createCustomHub()
@@ -931,9 +931,9 @@ public class Application {
UpdateHubVisibilityRequest req = UpdateHubVisibilityRequest.builder()
.sectionId(341650L)
.identifier("<value>")
.promotedToRecommended(BoolInt.ONE)
.promotedToOwnHome(BoolInt.ONE)
.promotedToSharedHome(BoolInt.ONE)
.promotedToRecommended(BoolInt.True)
.promotedToOwnHome(BoolInt.True)
.promotedToSharedHome(BoolInt.True)
.build();
UpdateHubVisibilityResponse res = sdk.hubs().updateHubVisibility()

106
docs/sdks/library/README.md
View File

@@ -100,7 +100,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetLibraryItemsRequest;
import dev.plexapi.sdk.models.operations.GetLibraryItemsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -123,6 +123,11 @@ public class Application {
.build();
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
@@ -272,8 +277,8 @@ public class Application {
IngestTransientItemRequest req = IngestTransientItemRequest.builder()
.url("file:///storage%2Femulated%2F0%2FArcher-S01E01.mkv")
.virtualFilePath("/Avatar.mkv")
.computeHashes(BoolInt.ONE)
.ingestNonMatches(BoolInt.ONE)
.computeHashes(BoolInt.True)
.ingestNonMatches(BoolInt.True)
.build();
IngestTransientItemResponse res = sdk.library().ingestTransientItem()
@@ -320,8 +325,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetLibraryMatchesRequest;
import dev.plexapi.sdk.models.operations.GetLibraryMatchesResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.BoolInt;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -344,9 +348,10 @@ public class Application {
.build();
GetLibraryMatchesRequest req = GetLibraryMatchesRequest.builder()
.includeFullMetadata(BoolInt.ONE)
.includeAncestorMetadata(BoolInt.ONE)
.includeAlternateMetadataSources(BoolInt.ONE)
.type(MediaType.TvShow)
.includeFullMetadata(BoolInt.True)
.includeAncestorMetadata(BoolInt.True)
.includeAlternateMetadataSources(BoolInt.True)
.build();
GetLibraryMatchesResponse res = sdk.library().getLibraryMatches()
@@ -413,7 +418,7 @@ public class Application {
.build();
OptimizeDatabaseRequest req = OptimizeDatabaseRequest.builder()
.async(BoolInt.ONE)
.async(BoolInt.True)
.build();
OptimizeDatabaseResponse res = sdk.library().optimizeDatabase()
@@ -602,8 +607,8 @@ public class Application {
"O:\fatboy\\Media\\My Music"))
.prefs(QueryParamPrefs.builder()
.build())
.relative(BoolInt.ONE)
.importFromiTunes(BoolInt.ONE)
.relative(BoolInt.True)
.importFromiTunes(BoolInt.True)
.build();
AddSectionResponse res = sdk.library().addSection()
@@ -818,6 +823,7 @@ import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetTagsRequest;
import dev.plexapi.sdk.models.operations.GetTagsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.MediaType;
import java.lang.Exception;
public class Application {
@@ -840,6 +846,7 @@ public class Application {
.build();
GetTagsRequest req = GetTagsRequest.builder()
.type(MediaType.TvShow)
.build();
GetTagsResponse res = sdk.library().getTags()
@@ -907,7 +914,7 @@ public class Application {
DeleteMetadataItemRequest req = DeleteMetadataItemRequest.builder()
.ids("<value>")
.proxy(BoolInt.ONE)
.proxy(BoolInt.True)
.build();
DeleteMetadataItemResponse res = sdk.library().deleteMetadataItem()
@@ -1234,7 +1241,7 @@ public class Application {
GenerateThumbsRequest req = GenerateThumbsRequest.builder()
.ids("<value>")
.force(BoolInt.ONE)
.force(BoolInt.True)
.build();
GenerateThumbsResponse res = sdk.library().generateThumbs()
@@ -1300,8 +1307,8 @@ public class Application {
DetectCreditsRequest req = DetectCreditsRequest.builder()
.ids("<value>")
.force(BoolInt.ONE)
.manual(BoolInt.ONE)
.force(BoolInt.True)
.manual(BoolInt.True)
.build();
DetectCreditsResponse res = sdk.library().detectCredits()
@@ -1564,7 +1571,7 @@ public class Application {
StartBifGenerationRequest req = StartBifGenerationRequest.builder()
.ids("<value>")
.force(BoolInt.ONE)
.force(BoolInt.True)
.build();
StartBifGenerationResponse res = sdk.library().startBifGeneration()
@@ -1630,7 +1637,7 @@ public class Application {
DetectIntrosRequest req = DetectIntrosRequest.builder()
.ids("<value>")
.force(BoolInt.ONE)
.force(BoolInt.True)
.build();
DetectIntrosResponse res = sdk.library().detectIntros()
@@ -1829,7 +1836,7 @@ public class Application {
ListMatchesRequest req = ListMatchesRequest.builder()
.ids("<value>")
.manual(BoolInt.ONE)
.manual(BoolInt.True)
.build();
ListMatchesResponse res = sdk.library().listMatches()
@@ -2100,7 +2107,7 @@ public class Application {
RefreshItemsMetadataRequest req = RefreshItemsMetadataRequest.builder()
.ids("<value>")
.markUpdated(BoolInt.ONE)
.markUpdated(BoolInt.True)
.build();
RefreshItemsMetadataResponse res = sdk.library().refreshItemsMetadata()
@@ -2362,8 +2369,8 @@ public class Application {
AddSubtitlesRequest req = AddSubtitlesRequest.builder()
.ids("<value>")
.forced(BoolInt.ONE)
.hearingImpaired(BoolInt.ONE)
.forced(BoolInt.True)
.hearingImpaired(BoolInt.True)
.build();
AddSubtitlesResponse res = sdk.library().addSubtitles()
@@ -2625,8 +2632,8 @@ public class Application {
DetectVoiceActivityRequest req = DetectVoiceActivityRequest.builder()
.ids("<value>")
.force(BoolInt.ONE)
.manual(BoolInt.ONE)
.force(BoolInt.True)
.manual(BoolInt.True)
.build();
DetectVoiceActivityResponse res = sdk.library().detectVoiceActivity()
@@ -2692,7 +2699,7 @@ public class Application {
GetAugmentationStatusRequest req = GetAugmentationStatusRequest.builder()
.augmentationId("<id>")
.wait_(BoolInt.ONE)
.wait_(BoolInt.True)
.build();
GetAugmentationStatusResponse res = sdk.library().getAugmentationStatus()
@@ -2758,7 +2765,7 @@ public class Application {
SetStreamSelectionRequest req = SetStreamSelectionRequest.builder()
.partId(360489L)
.allParts(BoolInt.ONE)
.allParts(BoolInt.True)
.build();
SetStreamSelectionResponse res = sdk.library().setStreamSelection()
@@ -2956,7 +2963,7 @@ public class Application {
DeleteLibrarySectionRequest req = DeleteLibrarySectionRequest.builder()
.sectionId("<id>")
.async(BoolInt.ONE)
.async(BoolInt.True)
.build();
DeleteLibrarySectionResponse res = sdk.library().deleteLibrarySection()
@@ -3022,7 +3029,7 @@ public class Application {
GetLibraryDetailsRequest req = GetLibraryDetailsRequest.builder()
.sectionId("<id>")
.includeDetails(BoolInt.ONE)
.includeDetails(BoolInt.True)
.build();
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
@@ -3204,7 +3211,7 @@ public class Application {
UpdateItemsRequest req = UpdateItemsRequest.builder()
.sectionId("<id>")
.fieldLocked(BoolInt.ONE)
.fieldLocked(BoolInt.True)
.build();
UpdateItemsResponse res = sdk.library().updateItems()
@@ -3310,7 +3317,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.AutocompleteRequest;
import dev.plexapi.sdk.models.operations.AutocompleteResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -3334,6 +3341,11 @@ public class Application {
AutocompleteRequest req = AutocompleteRequest.builder()
.sectionId(942007L)
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
AutocompleteResponse res = sdk.library().autocomplete()
@@ -3376,7 +3388,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetCollectionsRequest;
import dev.plexapi.sdk.models.operations.GetCollectionsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -3400,6 +3412,11 @@ public class Application {
GetCollectionsRequest req = GetCollectionsRequest.builder()
.sectionId(348838L)
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
GetCollectionsResponse res = sdk.library().getCollections()
@@ -3443,7 +3460,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetCommonRequest;
import dev.plexapi.sdk.models.operations.GetCommonResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -3467,6 +3484,11 @@ public class Application {
GetCommonRequest req = GetCommonRequest.builder()
.sectionId(298154L)
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
GetCommonResponse res = sdk.library().getCommon()
@@ -3639,7 +3661,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetFirstCharactersRequest;
import dev.plexapi.sdk.models.operations.GetFirstCharactersResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -3663,6 +3685,11 @@ public class Application {
GetFirstCharactersRequest req = GetFirstCharactersRequest.builder()
.sectionId(3947L)
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
GetFirstCharactersResponse res = sdk.library().getFirstCharacters()
@@ -4053,7 +4080,7 @@ public class Application {
RefreshSectionRequest req = RefreshSectionRequest.builder()
.sectionId(450300L)
.force(BoolInt.ONE)
.force(BoolInt.True)
.build();
RefreshSectionResponse res = sdk.library().refreshSection()
@@ -4650,7 +4677,7 @@ public class Application {
DeleteMediaItemRequest req = DeleteMediaItemRequest.builder()
.ids("<value>")
.mediaItem("<value>")
.proxy(BoolInt.ONE)
.proxy(BoolInt.True)
.build();
DeleteMediaItemResponse res = sdk.library().deleteMediaItem()
@@ -4822,7 +4849,7 @@ package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetSectionImageRequest;
import dev.plexapi.sdk.models.operations.GetSectionImageResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.*;
import java.lang.Exception;
public class Application {
@@ -4847,6 +4874,11 @@ public class Application {
GetSectionImageRequest req = GetSectionImageRequest.builder()
.sectionId(925611L)
.updatedAt(117413L)
.mediaQuery(MediaQuery.builder()
.type(MediaType.Episode)
.sourceType(2L)
.sort("duration:desc,index")
.build())
.build();
GetSectionImageResponse res = sdk.library().getSectionImage()
@@ -4978,7 +5010,7 @@ public class Application {
GetStreamRequest req = GetStreamRequest.builder()
.streamId(314506L)
.ext("<value>")
.autoAdjustSubtitle(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.True)
.build();
GetStreamResponse res = sdk.library().getStream()
@@ -5181,7 +5213,7 @@ public class Application {
.partId(877105L)
.changestamp(970622L)
.filename("example.file")
.download(BoolInt.ONE)
.download(BoolInt.True)
.build();
GetMediaPartResponse res = sdk.library().getMediaPart()

2
docs/sdks/libraryplaylists/README.md
View File

@@ -124,7 +124,7 @@ public class Application {
UploadPlaylistRequest req = UploadPlaylistRequest.builder()
.path("/home/barkley/playlist.m3u")
.force(BoolInt.ONE)
.force(BoolInt.True)
.build();
UploadPlaylistResponse res = sdk.libraryPlaylists().uploadPlaylist()

18
docs/sdks/playqueue/README.md
View File

@@ -60,11 +60,11 @@ public class Application {
CreatePlayQueueRequest req = CreatePlayQueueRequest.builder()
.type(Type.AUDIO)
.shuffle(BoolInt.ONE)
.repeat(BoolInt.ONE)
.continuous(BoolInt.ONE)
.recursive(BoolInt.ONE)
.onDeck(BoolInt.ONE)
.shuffle(BoolInt.True)
.repeat(BoolInt.True)
.continuous(BoolInt.True)
.recursive(BoolInt.True)
.onDeck(BoolInt.True)
.build();
CreatePlayQueueResponse res = sdk.playQueue().createPlayQueue()
@@ -132,9 +132,9 @@ public class Application {
GetPlayQueueRequest req = GetPlayQueueRequest.builder()
.playQueueId(210646L)
.own(BoolInt.ONE)
.includeBefore(BoolInt.ONE)
.includeAfter(BoolInt.ONE)
.own(BoolInt.True)
.includeBefore(BoolInt.True)
.includeAfter(BoolInt.True)
.build();
GetPlayQueueResponse res = sdk.playQueue().getPlayQueue()
@@ -202,7 +202,7 @@ public class Application {
AddToPlayQueueRequest req = AddToPlayQueueRequest.builder()
.playQueueId(919248L)
.next(BoolInt.ONE)
.next(BoolInt.True)
.build();
AddToPlayQueueResponse res = sdk.playQueue().addToPlayQueue()

69
docs/sdks/plex/README.md Normal file
View File

@@ -0,0 +1,69 @@
# Plex
(*plex()*)
## Overview
### Available Operations
* [getServerResources](#getserverresources) - Get Server Resources
## getServerResources
Get Plex server access tokens and server connections
### Example Usage
<!-- UsageSnippet language="java" operationID="get-server-resources" method="get" path="/resources" -->
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetServerResourcesUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("3381b62b-9ab7-4e37-827b-203e9809eb58")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetServerResourcesRequest req = GetServerResourcesRequest.builder()
.includeHttps(IncludeHttps.True)
.includeRelay(IncludeRelay.True)
.includeIPv6(IncludeIPv6.True)
.build();
GetServerResourcesResponse res = sdk.plex().getServerResources()
.request(req)
.call();
if (res.plexDevices().isPresent()) {
// handle response
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `request` | [GetServerResourcesRequest](../../models/operations/GetServerResourcesRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `serverURL` | *String* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**[GetServerResourcesResponse](../../models/operations/GetServerResourcesResponse.md)**
### Errors
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| models/errors/GetServerResourcesUnauthorized | 401 | application/json |
| models/errors/SDKError | 4XX, 5XX | \*/\* |

2
docs/sdks/search/README.md
View File

@@ -110,6 +110,7 @@ import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.VoiceSearchHubsRequest;
import dev.plexapi.sdk.models.operations.VoiceSearchHubsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.MediaType;
import java.lang.Exception;
public class Application {
@@ -133,6 +134,7 @@ public class Application {
VoiceSearchHubsRequest req = VoiceSearchHubsRequest.builder()
.query("<value>")
.type(MediaType.TvShow)
.build();
VoiceSearchHubsResponse res = sdk.search().voiceSearchHubs()

8
docs/sdks/subscriptions/README.md
View File

@@ -56,8 +56,8 @@ public class Application {
.build();
GetAllSubscriptionsRequest req = GetAllSubscriptionsRequest.builder()
.includeGrabs(BoolInt.ONE)
.includeStorage(BoolInt.ONE)
.includeGrabs(BoolInt.True)
.includeStorage(BoolInt.True)
.build();
GetAllSubscriptionsResponse res = sdk.subscriptions().getAllSubscriptions()
@@ -475,8 +475,8 @@ public class Application {
GetSubscriptionRequest req = GetSubscriptionRequest.builder()
.subscriptionId(186713L)
.includeGrabs(BoolInt.ONE)
.includeStorage(BoolInt.ONE)
.includeGrabs(BoolInt.True)
.includeStorage(BoolInt.True)
.build();
GetSubscriptionResponse res = sdk.subscriptions().getSubscription()

4
docs/sdks/timeline/README.md
View File

@@ -120,9 +120,9 @@ public class Application {
.playQueueItemID("123")
.time(0L)
.duration(10000L)
.continuing(BoolInt.ONE)
.continuing(BoolInt.True)
.updated(14200000L)
.offline(BoolInt.ONE)
.offline(BoolInt.True)
.timeToFirstFrame(1000L)
.timeStalled(1000L)
.bandwidth(100L)

48
docs/sdks/transcoder/README.md
View File

@@ -52,9 +52,9 @@ public class Application {
TranscodeImageRequest req = TranscodeImageRequest.builder()
.url("/library/metadata/265/thumb/1715112705")
.background("#ff5522")
.upscale(BoolInt.ONE)
.minSize(BoolInt.ONE)
.rotate(BoolInt.ONE)
.upscale(BoolInt.True)
.minSize(BoolInt.True)
.rotate(BoolInt.True)
.blendColor("#ff5522")
.build();
@@ -124,13 +124,13 @@ public class Application {
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.autoAdjustQuality(BoolInt.True)
.autoAdjustSubtitle(BoolInt.True)
.directPlay(BoolInt.True)
.directStream(BoolInt.True)
.directStreamAudio(BoolInt.True)
.disableResolutionRotation(BoolInt.True)
.hasMDE(BoolInt.True)
.location(Location.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)
@@ -281,13 +281,13 @@ public class Application {
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.autoAdjustQuality(BoolInt.True)
.autoAdjustSubtitle(BoolInt.True)
.directPlay(BoolInt.True)
.directStream(BoolInt.True)
.directStreamAudio(BoolInt.True)
.disableResolutionRotation(BoolInt.True)
.hasMDE(BoolInt.True)
.location(QueryParamLocation.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)
@@ -372,13 +372,13 @@ public class Application {
.advancedSubtitles(AdvancedSubtitles.BURN)
.audioBoost(50L)
.audioChannelCount(5L)
.autoAdjustQuality(BoolInt.ONE)
.autoAdjustSubtitle(BoolInt.ONE)
.directPlay(BoolInt.ONE)
.directStream(BoolInt.ONE)
.directStreamAudio(BoolInt.ONE)
.disableResolutionRotation(BoolInt.ONE)
.hasMDE(BoolInt.ONE)
.autoAdjustQuality(BoolInt.True)
.autoAdjustSubtitle(BoolInt.True)
.directPlay(BoolInt.True)
.directStream(BoolInt.True)
.directStreamAudio(BoolInt.True)
.disableResolutionRotation(BoolInt.True)
.hasMDE(BoolInt.True)
.location(StartTranscodeSessionQueryParamLocation.WAN)
.mediaBufferSize(102400L)
.mediaIndex(0L)

2
docs/sdks/ultrablur/README.md
View File

@@ -119,7 +119,7 @@ public class Application {
.bottomLeft("1c425d")
.width(1920L)
.height(1080L)
.noise(BoolInt.ONE)
.noise(BoolInt.True)
.build();
GetImageResponse res = sdk.ultraBlur().getImage()

6
docs/sdks/updater/README.md
View File

@@ -50,8 +50,8 @@ public class Application {
.build();
ApplyUpdatesRequest req = ApplyUpdatesRequest.builder()
.tonight(BoolInt.ONE)
.skip(BoolInt.ONE)
.tonight(BoolInt.True)
.skip(BoolInt.True)
.build();
ApplyUpdatesResponse res = sdk.updater().applyUpdates()
@@ -116,7 +116,7 @@ public class Application {
.build();
CheckUpdatesRequest req = CheckUpdatesRequest.builder()
.download(BoolInt.ONE)
.download(BoolInt.True)
.build();
CheckUpdatesResponse res = sdk.updater().checkUpdates()

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

@@ -0,0 +1,78 @@
# 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
<!-- UsageSnippet language="java" operationID="get-users" method="get" path="/users" -->
```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 dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws GetUsersBadRequest, GetUsersUnauthorized, Exception {
PlexAPI sdk = PlexAPI.builder()
.accepts(Accepts.APPLICATION_XML)
.clientIdentifier("3381b62b-9ab7-4e37-827b-203e9809eb58")
.product("Plex for Roku")
.version("2.4.1")
.platform("Roku")
.platformVersion("4.3 build 1057")
.device("Roku 3")
.model("4200X")
.deviceVendor("Roku")
.deviceName("Chrome")
.marketplace("googlePlay")
.token(System.getenv().getOrDefault("TOKEN", ""))
.build();
GetUsersRequest req = GetUsersRequest.builder()
.build();
GetUsersResponse res = sdk.users().getUsers()
.request(req)
.call();
if (res.object().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 | \*/\* |