Public/PublicReporting/Set-StatusCakeHelperPublicReportingPage.ps1
|
<# .SYNOPSIS Updates a StatusCake Public Reporting Page .DESCRIPTION Sets the configuration of StatusCake Public Reporting Page using the supplied parameters. .PARAMETER APICredential Credentials to access StatusCake API .PARAMETER ID ID of the StatusCake Public Reporting Page .PARAMETER SetByTitle Switch to update the public reporting page by title .PARAMETER Title The title of the Public Reporting Page .PARAMETER CName CName record for a custom domain .PARAMETER Password Password protection for the page. Leave empty to disable .PARAMETER Twitter Twitter handle to display with the @. Leave empty to disable .PARAMETER DisplayAnnotations Set to true to show annotations for status periods .PARAMETER DisplayOrbs Set to true to display uptime as colored orbs .PARAMETER SearchIndexing Set to false to disable search engine indexing .PARAMETER SortAlphabetical Set to true to order tests by alphabetical name .PARAMETER TestTags Set to true to select tests by their tag, rather than ID .PARAMETER TestIDs Array of TestIDs to be associated with Public Reporting page .PARAMETER TagsInclusive Set to true to select all tests that include one or more of the provided tags .PARAMETER Announcement Free text field that will appear as an announcement on the page .PARAMETER BgColor HEX value for the background colour .PARAMETER HeaderColor HEX value for the header colour .PARAMETER TitleColor HEX value for the header text colour .EXAMPLE C:\PS>Set-StatusCakeHelperPublicReportingPage -ID a1B2c3D4e5 -DisplayOrbs $false Update the public reporting page to display uptime figures instead of orbs #> function Set-StatusCakeHelperPublicReportingPage { [CmdletBinding(PositionalBinding=$false,SupportsShouldProcess=$true)] Param( [ValidateNotNullOrEmpty()] [System.Management.Automation.PSCredential] $APICredential = (Get-StatusCakeHelperAPIAuth), [Parameter(ParameterSetName='SetByID',Mandatory=$true)] [Parameter(ParameterSetName='UseTags',Mandatory=$true)] [Parameter(ParameterSetName='UseTestIDs',Mandatory=$true)] [string]$ID, [Parameter(ParameterSetName='SetByTitle',Mandatory=$true)] [Parameter(ParameterSetName='UseTags',Mandatory=$true)] [Parameter(ParameterSetName='UseTestIDs',Mandatory=$true)] [switch]$SetByTitle, [Parameter(ParameterSetName='NewPublicReportingPage',Mandatory=$true)] [Parameter(ParameterSetName='SetByTitle')] [Parameter(ParameterSetName='UseTags',Mandatory=$true)] [Parameter(ParameterSetName='UseTestIDs',Mandatory=$true)] [ValidateNotNullOrEmpty()] [string]$Title, [ValidatePattern('^([a-zA-Z0-9\-]+(\.[a-zA-Z]+)+)$')] [string]$CName, [ValidateNotNullOrEmpty()] [securestring]$Password, [ValidateNotNullOrEmpty()] [string]$Twitter, [Alias('display_annotations')] [boolean]$DisplayAnnotations, [Alias('display_orbs')] [boolean]$DisplayOrbs, [Alias('search_indexing')] [boolean]$SearchIndexing, [Alias('sort_alphabetical')] [boolean]$SortAlphabetical, [Parameter(ParameterSetName='SetByID')] [Parameter(ParameterSetName='SetByTitle')] [Parameter(ParameterSetName='NewPublicReportingPage')] [Parameter(ParameterSetName='UseTags',Mandatory=$true)] [string[]]$TestTags, [Parameter(ParameterSetName='SetByID')] [Parameter(ParameterSetName='SetByTitle')] [Parameter(ParameterSetName='NewPublicReportingPage')] [Parameter(ParameterSetName='UseTags')] [Alias('tags_inclusive')] [boolean]$TagsInclusive, [Parameter(ParameterSetName='SetByID')] [Parameter(ParameterSetName='SetByTitle')] [Parameter(ParameterSetName='UseTestIDs',Mandatory=$true)] [int[]]$TestIDs, [string]$Announcement, [ValidatePattern('^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$')] [Alias('bg_color')] [string]$BGColor, [ValidatePattern('^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$')] [Alias('header_color')] [string]$HeaderColor, [ValidatePattern('^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$')] [Alias('title_color')] [string]$TitleColor ) if($SetByTitle -and $Title) { #If setting page by title verify if a page or pages with that name exists if( $pscmdlet.ShouldProcess("StatusCake API", "Retrieve StatusCake Public Reporting Pages")) { $statusCakeItem = Get-StatusCakeHelperPublicReportingPage -APICredential $APICredential -Title $Title if(!$statusCakeItem) { Write-Error "No Public Reporting Page with Specified title Exists [$Title]" Return $null } elseif($statusCakeItem.GetType().Name -eq 'Object[]') { Write-Error "Multiple Public Reporting Pages with the same name [$Title] [$($statusCakeItem.id)]" Return $null } $ID = $statusCakeItem.id } } elseif($ID) { #If setting by id verify that id already exists if( $pscmdlet.ShouldProcess("StatusCake API", "Retrieve StatusCake Public Reporting Pages")) { $statusCakeItem = Get-StatusCakeHelperPublicReportingPage -APICredential $APICredential -ID $ID if(!$statusCakeItem) { Write-Error "No Public Reporting Page with Specified ID Exists [$ID]" Return $null } $ID = $statusCakeItem.id } } else { #Setup a page with the supplied details if( $pscmdlet.ShouldProcess("StatusCake API", "Retrieve StatusCake Public Reporting Pages") ) { $statusCakeItem = Get-StatusCakeHelperPublicReportingPage -APICredential $APICredential -Title $Title if($statusCakeItem) { Write-Error "Public Reporting Page with specified name already exists [$Title] [$($statusCakeItem.id)]" Return $null } } } $allParameterValues = $MyInvocation | Get-StatusCakeHelperParameterValue -BoundParameters $PSBoundParameters $apiParameterParams =@{"InvocationInfo" = $MyInvocation} If($TestTags -or $TestIDs) { if($TestTags) { $tests_or_tags = $TestTags $allParameterValues.Add("use_tags","true") } elseif($TestIDs) { $tests_or_tags = $TestIDs $allParameterValues.Add("use_tags","false") } $join = @{"Tests_or_Tags" = "|"} #Tags and tests for public reporting are separated by pipe symbol "|" $exclude = @("TestTags","TestIDs") $allParameterValues.Add("tests_or_tags",$tests_or_tags) $apiParameterParams.Add("join",$join) $apiParameterParams.Add("exclude",$exclude) } $lower = @('ID','Title','CName','Password','Twitter','Announcement') $statusCakeAPIParams = $allParameterValues | Get-StatusCakeHelperAPIParameter @apiParameterParams -ToLowerName $lower $statusCakeAPIParams = $statusCakeAPIParams | ConvertTo-StatusCakeHelperAPIParameter $requestParams = @{ uri = "https://app.statuscake.com//API/PublicReporting/Update" Headers = @{"Username"=$APICredential.Username;"API"=$APICredential.GetNetworkCredential().password} UseBasicParsing = $true method = "Post" ContentType = "application/x-www-form-urlencoded" body = $statusCakeAPIParams } if( $pscmdlet.ShouldProcess("StatusCake API", "Set StatusCake Public Reporting Page") ) { $response = Invoke-RestMethod @requestParams $requestParams=@{} $statusCakeAPIParams=@{} if($response.Success -ne "True") { Write-Error "$($response.Message) [$($response.Issues)]" Return $null } $responseId = $response.data.new_id if($ID) { #Updating a test does not return an id $responseId = $ID } $response = Get-StatusCakeHelperPublicReportingPageDetail -APICredential $APICredential -ID $responseId Return $response } } |