v0.12.2

Fixed

• Show comment based help correctly for Invoke-ShlinkRestMethod, mostly for PlatyPS and in-repository help markdown files

v0.12.0

Added

• New function Invoke-ShlinkRestMethod. This function will provide people with flexibility to use Shlink's REST API more directly if necessary; without the need to use this module's functions. Useful in scenarios where Shlink is updated with a breaking change or new endpoint not yet supported in PSShlink

Changed

• Changed the way the internal function InvokeShlinkRestMethod discovered the pagination property; this enabled a more user friendly implementation of the new public function Invoke-ShlinkRestMethod
• Deprecation warning added to Set-ShlinkUrl for -ValidateUrl, which is true since Shlink 3.5.0

v0.11.0

Added

• Added -AndroidLongUrl and -IOSLongUrl and -DesktopLongUrl to Set-Shlinkurl
• Added -AndroidLongUrl and -IOSLongUrl and -DesktopLongUrl to New-Shlinkurl
• Added -ExcludeMaxVisitsReached and -ExcludePastValidUntil to Get-ShlinkUrl
• Added -OrderBy permitted values nonBotVisits-ASC and nonBotVisits-DESC to Get-ShlinkUrl

Changed

• Minimum Shlink version updated to 3.5.0
• Deprecation warning added to New-ShlinkUrl for -ValidateUrl, which is true since Shlink 3.5.0
• Changed API permission to 3, from 2

v0.10.2

Fixed

• Updated comment based help for Get-ShlinkVisits for new domain parameter set

v0.10.0

Added

• Get-ShlinkVisits has a new parameter set to enable you to retrieve all visits for just domains. This supports the new GET /domains/{domain}/visits endpoint in 3.1.0.

Changed

• Minimum Shlink version updated 3.1.0

v0.9.4

Added

• New parameter -PassThru added to function Save-ShlinkUrlQrCode which will return a System.IO.FileSystemInfo object for each QR code image file it creates when used. Default behaviour has not changed (return no object if successful).

Changed

• Renamed parameter -Tags to be -Tag for function Remove-ShlinkTag

v0.9.1

Fixed

• Updated minimum version check of Shlink instance to 3.0.0
• Updated comment based help for Get-ShlinkVisistNonOrphan as it was copied from Get-ShlinkVisitsOprhan

v0.9.0

Added

• Function Get-ShlinkUrl has new parameter -TagsMode, new in Shlink 3.0.0
• Function Get-ShlinkTags has new parameter -SearchTerm, new in Shlink 3.0.0
• New function Get-ShlinkVisitsNonOrphan, new endpoint in Shlink 3.0.0
• New parameter -RoundBlockSize for Save-ShlinkUrlQrCode

Changed

• Get-ShlinkTags uses the new /tags/stats endpoint to include stats in the data returned. This change is purely internal of the function, does not impact how the function is used or how the data is returned.
• Get-ShlinkDomains now includes two parent properties when data is returned: data and defaultRedirects. In Shlink 2.10.0, this endpoint was updated to include the defaultRedirects property. Previously, all that was returned was everything within the data property.
• New parameter set of possible values for -OrderBy parameter of Get-ShlinkUrl function: longUrl-ASC, longUrl-DESC, shortCode-ASC, shortCode-DESC, dateCreated-ASC, dateCreated-DESC, visits-ASC, visits-DESC, title-ASC, and title-DESC

Removed

• Function New-ShlinKTag as the endpoint was removed from Shlink REST API in 3.0.0

Fixed

• Remove-ShlinkTag ShouldProcess prompts listed the entire array of tags passed to it, rather than the current iterable it was working on

v0.8.2

Fixed

• Renamed parameter DoNotValidateUrl to ValidateUrl in comment based help for Set-ShlinkUrl

v0.8.1

Fixed

• Updated warnings about minimum Shlink version to suggest 2.9.0