Public/Set/Set-HaloFAQList.ps1

Function Set-HaloFAQList {
    <#
        .SYNOPSIS
            Updates a FAQ List via the Halo API.
        .DESCRIPTION
            Function to send an FAQ List update request to the Halo API
        .OUTPUTS
            Outputs an object containing the response from the web request.
    #>

    [CmdletBinding( SupportsShouldProcess = $True )]
    [OutputType([Object])]
    Param (
        # Object containing properties and values used to update an existing knowedgebase article.
        [Parameter( Mandatory = $True, ValueFromPipeline )]
        [Object]$FAQList
    )
    Invoke-HaloPreFlightCheck
    try {
        if ($null -eq $FAQList.id) {
            throw 'FAQ list ID is required.'
        }
        $ObjectToUpdate = Get-HaloFAQList -FAQListID $FAQList.id
        if ($ObjectToUpdate) {
            if ($PSCmdlet.ShouldProcess("FAQ List '$($ObjectToUpdate.name)'", 'Update')) {
                New-HaloPOSTRequest -Object $FAQList -Endpoint 'FAQLists'
            }
        } else {
            Throw 'FAQ List was not found in Halo to update.'
        }
    } catch {
        New-HaloError -ErrorRecord $_
    }
}