Get-CharacterCollectedToys.ps1
|
function Get-CharacterCollectedToys { <# .SYNOPSIS Retrieves a list of toys collected by a World of Warcraft character. .DESCRIPTION The function fetches a list of collected toys for a given character using the World of Warcraft API. The realm slug and character name are required parameters. An optional switch is available to return raw JSON data. .PARAMETER realmSlug The slug of the realm. This is required and must not be empty. .PARAMETER characterName The name of the character. This is required and must not be empty. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-CharacterCollectedToys -realmSlug 'azshara' -characterName 'strandmaus' Retrieves the collected toys for the character named Strandmaus on the Azshara realm. .EXAMPLE Get-CharacterCollectedToys -realmSlug 'azshara' -characterName 'strandmaus' -Raw Retrieves the raw JSON response of collected toys for the character named Strandmaus on the Azshara realm. .NOTES This function requires the World of Warcraft API to be accessible and valid credentials to be configured in the global variables. .LINK https://develop.battle.net/documentation/world-of-warcraft/profile-apis #> param ( [Parameter(Mandatory, Position = 0, HelpMessage = 'The slug of the realm.')] [ValidateNotNullOrEmpty()] [String]$realmSlug, [Parameter(Mandatory, Position = 1, HelpMessage = 'The character name.')] [ValidateNotNullOrEmpty()] [String]$characterName, [Parameter(Position = 2, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) $realmSlug = $realmSlug.ToLower() $characterName = $characterName.ToLower() if(Test-WoWApiConnection) { $URL = '{0}profile/wow/character/{1}/{2}/collections/toys?namespace=profile-{3}&locale={4}' -f $Global:WoWBaseURL, $realmSlug, $characterName, $Global:WoWRegion, $Global:WoWLocalization try { $result = Invoke-RestMethod -Uri $URL -Headers $Global:WoWApiAuthHeader -TimeoutSec 5 if($result -and $result.PSobject.Properties.name -contains 'toys') { if($Raw) { return $result } else { return $result | Select-Object -ExpandProperty toys | Select-Object -ExpandProperty toy | Sort-Object -Property id } } } catch { $statusCode = $_.Exception.Response.StatusCode.value__ $status = $_.Exception.Response.StatusCode Write-Verbose -Message ('Bad status code ({0}) {1}' -f $statusCode, $status) } } } |