Public/Get-GW2Pets.ps1
|
<#
.SYNOPSIS Retrieves pet information from the Guild Wars 2 API. .DESCRIPTION Calls the Guild Wars 2 API v2 /pets endpoint. - If no parameters are provided, returns a list of all available pet IDs. - If 'Ids' is provided, returns objects containing details for the specified pets. - If 'All' is specified, returns all available pets. .PARAMETER Ids Optional. A list of pet IDs (integers) to retrieve. Example: 1, 33 .PARAMETER All Optional. If set, retrieves all pets. .PARAMETER Lang Optional. The language to return results in (en, es, de, fr, ko, zh). .EXAMPLE Get-GW2Pets Returns a list of all pet IDs. .EXAMPLE Get-GW2Pets -Ids 1, 33 Returns details for the specified pets. .EXAMPLE Get-GW2Pets -All Returns details for all pets. .NOTES - Requires network access to api.guildwars2.com. - This is a public endpoint and does not require an API key. #> function Get-GW2Pets { param ( [Parameter(Mandatory = $false)] [int[]]$Ids, [Parameter(Mandatory = $false)] [switch]$All, [Parameter(Mandatory = $false)] [ValidateSet("en", "es", "de", "fr", "ko", "zh")] [string]$Lang ) $url = "https://api.guildwars2.com/v2/pets" if ($All) { $url = $url + "?ids=all" } elseif ($Ids) { # Join IDs with commas for the query parameter $idString = $Ids -join ',' $url = $url + "?ids=$idString" } if ($Lang) { if ($url.Contains("?")) { $url = $url + "&lang=$Lang" } else { $url = $url + "?lang=$Lang" } } $response = Invoke-RestMethod -Uri $url -Method Get return $response } |