added new HomeUsers api

Author: Kevin Jensen

Source/Plex.Library/ApiModels/Accounts/PlexAccount.cs

@@ -198,6 +198,13 @@ public async Task<ResourceContainer> Resources() =>
         public async Task<List<Friend>> Friends() =>
             await this.plexAccountClient.GetFriendsAsync(this.AuthToken);
 
+        // CreateHomeUser()
+        // CreateExistingUser()
+        // RemoveFriend()
+        // RemoveHomeUser()
+        // UpdateFriend()
+        // GetUser(string username)
+
         /// <summary>
         /// Return list of Movie and Show items in the user's Watchlist.
         /// Note: Objects returned are from Plex's online metadata service.  You will need to lookup items on the
@@ -219,7 +226,7 @@ public async Task<List<Friend>> Friends() =>
         /// <returns>List of Movies or Shows</returns>
         public async Task<WatchlistMetadataContainer[]> Watchlist(string filter, string sort, SearchType? libraryType)
         {
-            var watchlist = await this.plexAccountClient.GetWatchList(this.AuthToken, filter, sort, libraryType);
+            var watchlist = await this.plexAccountClient.GetWatchListAsync(this.AuthToken, filter, sort, libraryType);
 
             if (watchlist.Size > 0 && watchlist.MediaContainers.Any())
             {
@@ -239,13 +246,11 @@ public async Task<AnnouncementContainer> Announcements() =>
             await this.plexAccountClient.GetPlexAnnouncementsAsync(this.AuthToken);
 
         /// <summary>
-        /// Returns a list of all User objects connected to your account.
-        /// This includes both friends and pending invites. You can reference the user.Friend to
-        /// distinguish between the two.
+        /// Returns a list of Home Users for Account
         /// </summary>
         /// <returns>UserContainer Object</returns>
-        public async Task<UserContainer> Users() =>
-            await this.plexAccountClient.GetUsers(this.AuthToken);
+        public async Task<UserContainer> HomeUsers() =>
+            await this.plexAccountClient.GetHomeUsersAsync(this.AuthToken);
 
 
 
@@ -255,9 +260,9 @@ public async Task<UserContainer> Users() =>
         /// distinguish between the two.
         /// </summary>
         /// <returns>UserContainer Object</returns>
-        public async Task<PlexAccount> GetPlexHomeAccountAsync(string userUUID)
+        public async Task<PlexAccount> GetPlexHomeAccountAsync(string userUuid)
         {
-            var account = await this.plexAccountClient.GetPlexHomeAccountAsync(this.AuthToken, userUUID);
+            var account = await this.plexAccountClient.GetPlexHomeAccountAsync(this.AuthToken, userUuid);
             if (account == null)
             {
                 return null;
@@ -275,22 +280,16 @@ public async Task<PlexAccount> GetPlexHomeAccountAsync(string userUUID)
         /// <param name="library">Opt out of Library statistics</param>
         /// <returns></returns>
         public async Task OptOut(bool playback, bool library) =>
-            await this.plexAccountClient.OptOut(this.AuthToken, playback, library);
+            await this.plexAccountClient.OptOutAsync(this.AuthToken, playback, library);
 
         /// <summary>
         /// Get Account Devices
         /// </summary>
         /// <returns>List of Device objects</returns>
         public async Task<List<Device>> Devices() =>
-            await this.plexAccountClient.GetDevices(this.AuthToken);
+            await this.plexAccountClient.GetDevicesAsync(this.AuthToken);
 
 
-        // CreateHomeUser()
-        // CreateExistingUser()
-        // RemoveFriend()
-        // RemoveHomeUser()
-        // UpdateFriend()
-        // GetUser(string username)
 
         // AddWebhook(string url);
         // DeleteWebhook(string url);

Source/Plex.ServerApi/Clients/Interfaces/IPlexAccountClient.cs

@@ -88,13 +88,13 @@ public interface IPlexAccountClient
         Task<List<Friend>> GetFriendsAsync(string authToken);
 
         /// <summary>
-        /// Returns a list of all User objects connected to your account.
+        /// Returns a list of User objects connected to your account.
         /// This includes both friends and pending invites. You can reference the User.Friend to
         /// distinguish between the two.
         /// </summary>
         /// <param name="authToken">Authentication Token.</param>
         /// <returns>List of Users</returns>
-        Task<UserContainer> GetUsers(string authToken);
+        Task<UserContainer> GetHomeUsersAsync(string authToken);
 
         /// <summary>
         /// Opt in or out of sharing stuff with plex.
@@ -104,21 +104,21 @@ public interface IPlexAccountClient
         /// <param name="playback">Opt out of playback</param>
         /// <param name="library">Opt out of Library statistics</param>
         /// <returns></returns>
-        Task OptOut(string authToken, bool playback, bool library);
+        Task OptOutAsync(string authToken, bool playback, bool library);
 
         /// <summary>
         /// Returns a list of all Device objects connected to the account.
         /// </summary>
         /// <param name="authToken">Authentication Token.</param>
         /// <returns></returns>
-        Task<List<Device>> GetDevices(string authToken);
+        Task<List<Device>> GetDevicesAsync(string authToken);
 
         /// <summary>
         /// Link a device to Plex Account using Pin Auth
         /// </summary>
         /// <param name="pinCode"></param>
         /// <returns></returns>
-        Task<object> LinkDeviceToAccountByPin(string pinCode);
+        Task<object> LinkDeviceToAccountByPinAsync(string pinCode);
 
         /// <summary>
         /// Switch to the account of another Home User
@@ -148,7 +148,7 @@ public interface IPlexAccountClient
         /// </param>
         /// <param name="searchType">Library Type (either 'movie' or 'show').  Empty string will return all items.</param>
         /// <returns>List of Movies or Shows</returns>
-        Task<WatchlistContainer> GetWatchList(string authToken, string filter, string sort, SearchType? searchType);
+        Task<WatchlistContainer> GetWatchListAsync(string authToken, string filter, string sort, SearchType? searchType);
 
         /// <summary>
         /// Search for Movies and TV shows in Discover
@@ -157,46 +157,46 @@ public interface IPlexAccountClient
         /// <param name="query">Search Query</param>
         /// <param name="limit">Limit number of items to return. Default is 30</param>
         /// <returns>List of Discover objects</returns>
-        Task<DiscoverSearchContainer> SearchDiscover(string authToken, string query, int limit = 30);
+        Task<DiscoverSearchContainer> SearchDiscoverAsync(string authToken, string query, int limit = 30);
 
         /// <summary>
         /// Returns True or False depending on if Item is on Watchlist
         /// </summary>
         /// <param name="authToken">Plex Auth Token</param>
         /// <param name="ratingKey">Item Rating Key</param>
         /// <returns></returns>
-        Task<bool> OnWatchlist(string authToken,string ratingKey);
+        Task<bool> OnWatchlistAsync(string authToken,string ratingKey);
 
         /// <summary>
         ///
         /// </summary>
         /// <param name="authToken">Plex Auth Token</param>
         /// <param name="ratingKey">Item Rating Key</param>
         /// <returns></returns>
-        Task AddToWatchlist(string authToken, string ratingKey);
+        Task AddToWatchlistAsync(string authToken, string ratingKey);
 
         /// <summary>
         ///
         /// </summary>
         /// <param name="authToken">Plex Auth Token</param>
         /// <param name="ratingKey">Item Rating Key</param>
         /// <returns></returns>
-        Task RemoveFromWatchlist(string authToken, string ratingKey);
+        Task RemoveFromWatchlistAsync(string authToken, string ratingKey);
 
         /// <summary>
         /// Get Shared Items for Admin Account
         /// </summary>
         /// <param name="authToken">Plex Auth Token</param>
         /// <returns>List of Shared Items and the Users associated</returns>
-        Task<List<SharedItemContainer>> GetSharedItems(string authToken);
+        Task<List<SharedItemContainer>> GetSharedItemsAsync(string authToken);
 
         /// <summary>
         /// Remove Shared Item for Admin Account
         /// </summary>
         /// <param name="authToken">Plex Auth Token</param>
         /// <param name="sharedItemId">Shared Item Identifier</param>
         /// <returns></returns>
-        Task RemoveSharedItem(string authToken, int sharedItemId);
+        Task RemoveSharedItemAsync(string authToken, int sharedItemId);
 
         /// <summary>
         /// Add Shared items from Admin Account to another user
@@ -205,6 +205,6 @@ public interface IPlexAccountClient
         /// <param name="sharedUserId">User Id to share with</param>
         /// <param name="sharedItems">Items to share</param>
         /// <returns></returns>
-        Task AddSharedItems(string authToken, int sharedUserId,  List<SharedItemModelRequest> sharedItems);
+        Task AddSharedItemsAsync(string authToken, int sharedUserId,  List<SharedItemModelRequest> sharedItems);
     }
 }

Source/Plex.ServerApi/Clients/PlexAccountClient.cs

@@ -196,9 +196,9 @@ public async Task<List<Friend>> GetFriendsAsync(string authToken)
         }
 
         /// <inheritdoc/>
-        public async Task<UserContainer> GetUsers(string authToken)
+        public async Task<UserContainer> GetHomeUsersAsync(string authToken)
         {
-            var apiRequest = new ApiRequestBuilder("https://plex.tv/api/users", string.Empty, HttpMethod.Get)
+            var apiRequest = new ApiRequestBuilder("https://plex.tv/home/users", string.Empty, HttpMethod.Get)
                 .AddPlexToken(authToken)
                 .AddRequestHeaders(ClientUtilities.GetClientIdentifierHeader(this.clientOptions.ClientId))
                 .AddRequestHeaders(ClientUtilities.GetClientMetaHeaders(this.clientOptions))
@@ -209,7 +209,7 @@ public async Task<UserContainer> GetUsers(string authToken)
         }
 
         /// <inheritdoc/>
-        public async Task OptOut(string authToken, bool playback, bool library)
+        public async Task OptOutAsync(string authToken, bool playback, bool library)
         {
             var queryParams = new Dictionary<string, string>
             {
@@ -229,7 +229,7 @@ public async Task OptOut(string authToken, bool playback, bool library)
         }
 
         /// <inheritdoc/>
-        public async Task<List<Device>> GetDevices(string authToken)
+        public async Task<List<Device>> GetDevicesAsync(string authToken)
         {
             var apiRequest =
                 new ApiRequestBuilder("https://plex.tv/devices.json",string.Empty, HttpMethod.Get)
@@ -245,7 +245,7 @@ public async Task<List<Device>> GetDevices(string authToken)
         }
 
         /// <inheritdoc/>
-        public async Task<object> LinkDeviceToAccountByPin(string pinCode)
+        public async Task<object> LinkDeviceToAccountByPinAsync(string pinCode)
         {
             var apiRequest =
                 new ApiRequestBuilder("https://plex.tv/api/v2/pins/link", string.Empty,HttpMethod.Put)
@@ -259,7 +259,7 @@ public async Task<object> LinkDeviceToAccountByPin(string pinCode)
         }
 
         /// <inheritdoc/>
-        public async Task<WatchlistContainer> GetWatchList(string authToken, string filter, string sort, SearchType? searchType)
+        public async Task<WatchlistContainer> GetWatchListAsync(string authToken, string filter, string sort, SearchType? searchType)
         {
             var queryParams = new Dictionary<string, string>
             {
@@ -295,7 +295,7 @@ public async Task<WatchlistContainer> GetWatchList(string authToken, string filt
         }
 
         /// <inheritdoc/>
-        public async Task<object> GetHistory(string authToken, int maxResults = 999999)
+        public async Task<object> GetHistoryAsync(string authToken, int maxResults = 999999)
         {
             var queryParams = new Dictionary<string, string>
             {
@@ -317,7 +317,7 @@ public async Task<object> GetHistory(string authToken, int maxResults = 999999)
         }
 
         /// <inheritdoc/>
-        public async Task<DiscoverSearchContainer> SearchDiscover(string authToken, string query, int limit = 30)
+        public async Task<DiscoverSearchContainer> SearchDiscoverAsync(string authToken, string query, int limit = 30)
         {
             var queryParams = new Dictionary<string, string>
             {
@@ -340,7 +340,7 @@ public async Task<DiscoverSearchContainer> SearchDiscover(string authToken, stri
         }
 
         /// <inheritdoc/>
-        public async Task<bool> OnWatchlist(string authToken, string ratingKey)
+        public async Task<bool> OnWatchlistAsync(string authToken, string ratingKey)
         {
             var apiRequest =
                 new ApiRequestBuilder($"https://metadata.provider.plex.tv/library/metadata/{ratingKey}/userState", string.Empty, HttpMethod.Get)
@@ -355,7 +355,7 @@ public async Task<bool> OnWatchlist(string authToken, string ratingKey)
         }
 
         /// <inheritdoc/>
-        public async Task AddToWatchlist(string authToken, string ratingKey)
+        public async Task AddToWatchlistAsync(string authToken, string ratingKey)
         {
             if (string.IsNullOrEmpty(ratingKey))
             {
@@ -379,7 +379,7 @@ public async Task AddToWatchlist(string authToken, string ratingKey)
         }
 
         /// <inheritdoc/>
-        public async Task RemoveFromWatchlist(string authToken, string ratingKey)
+        public async Task RemoveFromWatchlistAsync(string authToken, string ratingKey)
         {
 
             if (string.IsNullOrEmpty(ratingKey))
@@ -404,7 +404,7 @@ public async Task RemoveFromWatchlist(string authToken, string ratingKey)
         }
 
         /// <inheritdoc/>
-        public async Task<List<SharedItemContainer>> GetSharedItems(string authToken)
+        public async Task<List<SharedItemContainer>> GetSharedItemsAsync(string authToken)
         {
             var queryParams = new Dictionary<string, string>
             {
@@ -426,7 +426,7 @@ public async Task<List<SharedItemContainer>> GetSharedItems(string authToken)
         }
 
         /// <inheritdoc/>
-        public async Task RemoveSharedItem(string authToken, int sharedItemId)
+        public async Task RemoveSharedItemAsync(string authToken, int sharedItemId)
         {
             var apiRequest =
                 new ApiRequestBuilder($"https://plex.tv/api/v2/shared_sources/{sharedItemId}", string.Empty,
@@ -441,7 +441,7 @@ public async Task RemoveSharedItem(string authToken, int sharedItemId)
         }
 
         /// <inheritdoc/>
-        public async Task AddSharedItems(string authToken, int sharedUserId, List<SharedItemModelRequest> sharedItems)
+        public async Task AddSharedItemsAsync(string authToken, int sharedUserId, List<SharedItemModelRequest> sharedItems)
         {
             var queryParams =
                 new Dictionary<string, string>