Public/Alerts/Get-StatusCakeHelperSentAlerts.ps1
|
<# .Synopsis Retrieves alerts that have been sent in relation to tests setup on the account .PARAMETER baseAlertURL Base URL endpoint of the statuscake alert API .PARAMETER Username Username associated with the API key .PARAMETER ApiKey APIKey to access the StatusCake API .PARAMETER TestID ID of the Test to retrieve the sent alerts for .PARAMETER TestName Name of the Test to retrieve the sent alerts for .PARAMETER Since Supply to include results only since the specified date .OUTPUTS Returns an object with the details on the Alerts Sent .EXAMPLE Get-StatusCakeHelperSentAlerts -TestID 123456 -since "2017-08-19 13:29:49" .FUNCTIONALITY Retrieves alerts that have been sent in regards to tests setup on the account #> function Get-StatusCakeHelperSentAlerts { [CmdletBinding(PositionalBinding=$false,SupportsShouldProcess=$true)] Param( $baseAlertURL = "https://app.statuscake.com/API/Alerts/", [ValidateNotNullOrEmpty()] $Username = (Get-StatusCakeHelperAPIAuth).Username, [ValidateNotNullOrEmpty()] $ApiKey = (Get-StatusCakeHelperAPIAuth).GetNetworkCredential().password, [int]$TestID, [ValidateNotNullOrEmpty()] [string]$TestName, [datetime]$Since ) $authenticationHeader = @{"Username"="$Username";"API"="$ApiKey"} $statusCakeFunctionAuth = @{"Username"=$Username;"Apikey"=$ApiKey} Write-Warning "This function will be renamed to Get-StatusCakeHelperSentAlert in the next release" if($TestName) { if( $pscmdlet.ShouldProcess("StatusCake API", "Retrieve StatusCake Tests") ) { $testCheck = Get-StatusCakeHelperTest @statusCakeFunctionAuth -TestName $TestName if($testCheck.GetType().Name -eq 'Object[]') { Write-Error "Multiple Tests found with name [$TestName] [$($testCheck.TestID)]. Please retrieve sent alerts via TestID" Return $null } $TestID = $testCheck.TestID else { Write-Error "Unable to find Test with name [$TestName]" Return $null } } } $psParams = @{} $ParameterList = (Get-Command -Name $MyInvocation.InvocationName).Parameters $ParamsToIgnore = @("baseAlertURL","Username","ApiKey","TestName") foreach ($key in $ParameterList.keys) { $var = Get-Variable -Name $key -ErrorAction SilentlyContinue; if($ParamsToIgnore -contains $var.Name) { continue } elseif($var.value -or $var.value -eq 0) { $psParams.Add($var.name,$var.value) } } $statusCakeAPIParams = $psParams | ConvertTo-StatusCakeHelperAPIParams $requestParams = @{ uri = $baseAlertURL Headers = $authenticationHeader UseBasicParsing = $true method = "Get" ContentType = "application/x-www-form-urlencoded" body = $statusCakeAPIParams } if( $pscmdlet.ShouldProcess("StatusCake API", "Retrieve StatusCake Sent Alerts") ) { $jsonResponse = Invoke-WebRequest @requestParams $response = $jsonResponse | ConvertFrom-Json Return $response } } |