Merge pull request #11 from robinmalik/development

Release 1.0.14
robinmalik · Oct 15, 2023 · 81c0962 · 81c0962
2 parents 4d05976 + 3b497f3
commit 81c0962
Show file tree

Hide file tree

Showing 36 changed files with 658 additions and 112 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -8,11 +8,12 @@ jobs:
   publish-to-gallery:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
+
       - name: Build and publish
-        env:
-          NUGET_KEY: ${{ secrets.NUGET_KEY }}
-        shell: pwsh
-        run: |
-          echo "The current path is: $($pwd.path)"
-          Publish-Module -Path "../Source" -NuGetApiKey $env:NUGET_KEY -Verbose
+        uses: natescherer/publish-powershell-action@v1
+        with:
+          token: ${{ secrets.NUGET_KEY }}
+          target: gallery
+          path: Source
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,19 @@
 # Changelog
 
-## [1.0.13] - 2023-01-09
+## [1.0.14] - 2023-10-15
+
+* ✨ [New] `Set-PlexDefaultServer` for setting the default server to use for all future calls.
+    * Context: `Set-PlexConfiguration` is called, a default is set as part of this. This function allows you to change it.
+* ✨ [New] `Get-PlexPlaylist` and `Get-PlexLibrary` now support `-Name`. The Plex API doesn't support this natively, so it's client side filtered.
+* ✨ [New] `Get-PlexWatchHistory` for returning the watch history for either yourself or another user (with `-Username`).
+
+## [1.0.13] - 2023-09-02
 
 * 🔨 [Changed] BREAKING CHANGES: Removed `Get-PlexAuthenticationToken` and `Save-PlexConfiguration`. We now have a single function: `Set-PlexConfiguration`.
 * 🔨 [Changed] BREAKING CHANGES: Reworked credential file structure, including removal of token encryption for Windows.
 * ✨ [New] `Set-PlexItemEdition` for setting the 'edition' of movie items.
 
-## [1.0.12] - 2023-13-01
+## [1.0.12] - 2023-01-13
 
 * ✨ [New] `New-PlexPlaylist` for creating new (video) playlists.
 * 🐛 [Fixed] Ensure `Get-PlexPlaylist -IncludeItems` doesn't throw an error for 'Smart' playlists.

diff --git a/Documentation/Get-PlexLibrary.md b/Documentation/Get-PlexLibrary.md
@@ -12,8 +12,19 @@ By default, returns a list of libraries on a Plex server.
 
 ## SYNTAX
 
+### All (Default)
 ```
-Get-PlexLibrary [[-Id] <String>] [<CommonParameters>]
+Get-PlexLibrary [<CommonParameters>]
+```
+
+### Id
+```
+Get-PlexLibrary [-Id <String>] [<CommonParameters>]
+```
+
+### Name
+```
+Get-PlexLibrary [-Name <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -34,11 +45,26 @@ If specified, returns a specific library.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: Id
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Name
+{{ Fill Name Description }}
+
+```yaml
+Type: String
+Parameter Sets: Name
 Aliases:
 
 Required: False
-Position: 1
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False

diff --git a/Documentation/Get-PlexPlaylist.md b/Documentation/Get-PlexPlaylist.md
@@ -12,8 +12,20 @@ Gets playlists.
 
 ## SYNTAX
 
+### All (Default)
 ```
-Get-PlexPlaylist [[-Id] <String>] [-IncludeItems] [[-AlternativeToken] <String>] [-WhatIf] [-Confirm]
+Get-PlexPlaylist [-IncludeItems] [-AlternativeToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### Id
+```
+Get-PlexPlaylist [-Id <String>] [-IncludeItems] [-AlternativeToken <String>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
+```
+
+### Name
+```
+Get-PlexPlaylist [-Name <String>] [-IncludeItems] [-AlternativeToken <String>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -40,11 +52,26 @@ The id of the playlist to get.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: Id
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Name
+{{ Fill Name Description }}
+
+```yaml
+Type: String
+Parameter Sets: Name
 Aliases:
 
 Required: False
-Position: 1
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -76,7 +103,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False

diff --git a/Documentation/Get-PlexServer.md b/Documentation/Get-PlexServer.md
@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-PlexServer
 
 ## SYNOPSIS
-Returns a list of online Plex Servers that you have access to.
+Returns a list of online Plex Servers that you have access to (remote access must be enabled).
 
 ## SYNTAX
 
@@ -17,7 +17,7 @@ Get-PlexServer [[-Name] <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-Returns a list of online Plex Servers that you have access to.
+Returns a list of online Plex Servers that you have access to (remote access must be enabled).
 
 ## EXAMPLES
 
@@ -50,6 +50,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## OUTPUTS
 
+### ```
 ### accessToken       : abcd123456ABCDEFG
 ### name              : thor
 ### address           : 87.50.66.123
@@ -79,6 +80,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### sourceTitle       : username_of_friend
 ### ownerId           : 6728195
 ### home              : 0
+### ```
 ## NOTES
 
 ## RELATED LINKS
diff --git a/Documentation/Get-PlexShare.md b/Documentation/Get-PlexShare.md
@@ -8,7 +8,7 @@ schema: 2.0.0
 # Get-PlexShare
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Gets a user and the share status of your libraries with them.
 
 ## SYNTAX
 
@@ -23,26 +23,36 @@ Get-PlexShare [-Email <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Gets a user and the share status of your libraries with them.
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+Get-PlexShare -Username "username"
 ```
 
-{{ Add example description here }}
+### EXAMPLE 2
+```
+# Get share status for a single user:
+Get-PlexShare -Username "username" | Select -ExpandProperty section
+```
+
+### EXAMPLE 3
+```
+# Get share status for all users:
+Get-PlexUser | Select username | % { Get-PlexShare -Username $_.username }
+```
 
 ## PARAMETERS
 
-### -Confirm
-Prompts you for confirmation before running the cmdlet.
+### -Username
+The username of the user to query share status.
 
 ```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases: cf
+Type: String
+Parameter Sets: username
+Aliases:
 
 Required: False
 Position: Named
@@ -52,7 +62,7 @@ Accept wildcard characters: False
 ```
 
 ### -Email
-{{ Fill Email Description }}
+The email address of the user to query share status.
 
 ```yaml
 Type: String
@@ -66,13 +76,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Username
-{{ Fill Username Description }}
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
 
 ```yaml
-Type: String
-Parameter Sets: username
-Aliases:
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
 
 Required: False
 Position: Named
@@ -81,14 +92,13 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -WhatIf
-Shows what would happen if the cmdlet runs.
-The cmdlet is not run.
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: wi
+Aliases: cf
 
 Required: False
 Position: Named
@@ -102,11 +112,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### None
-
 ## OUTPUTS
 
-### System.Object
+### username allowSync section                                 invitedAt
+### -------- --------- -------                                 ---------
+### person1  1         {Section, Section, Section, Section...} 16/01/2022 19:01:39
+### person2  0         {Section, Section, Section, Section...} 08/01/2022 20:15:31
 ## NOTES
 
 ## RELATED LINKS
diff --git a/Documentation/Get-PlexWatchHistory.md b/Documentation/Get-PlexWatchHistory.md
@@ -0,0 +1,87 @@
+---
+external help file: PSPlex-help.xml
+Module Name: PSPlex
+online version:
+schema: 2.0.0
+---
+
+# Get-PlexWatchHistory
+
+## SYNOPSIS
+Returns a list of watched/listened to items from the Plex server.
+
+## SYNTAX
+
+```
+Get-PlexWatchHistory [[-Username] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Returns a list of watched/listened to items from the Plex server.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-PlexWatchHistory
+```
+
+## PARAMETERS
+
+### -Username
+Optional.
+If specified, only return items watched by this user.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS