HaloAPI

1.9.1-Beta1

Public/Set/Set-HaloStatus.ps1

Function Set-HaloStatus {
    <#
        .SYNOPSIS
            Updates one or more statuses via the Halo API.
        .DESCRIPTION
            Function to send a status update request to the Halo API
        .OUTPUTS
            Outputs an object containing the response from the web request.
    #>
    [CmdletBinding( SupportsShouldProcess = $True )]
    [OutputType([Object[]])]
    Param (
        # Object or array of objects containing properties and values used to update one or more existing statuses.
        [Parameter( Mandatory = $True, ValueFromPipeline )]
        [Object[]]$Status
    )
    Invoke-HaloPreFlightCheck
    try {
        $ObjectToUpdate = $Status | ForEach-Object {
            if ($null -eq $_.id) {
                throw 'Status ID is required.'
            }
            $HaloStatusParams = @{
                StatusId = $_.id
            }
            $StatusExists = Get-HaloStatus @HaloStatusParams
            if ($StatusExists) {
                Return $True
            } else {
                Return $False
            }
        }
        if ($False -notin $ObjectToUpdate) {
            if ($PSCmdlet.ShouldProcess($Status -is [Array] ? 'Statuses' : 'Status', 'Update')) {
                New-HaloPOSTRequest -Object $Status -Endpoint 'status'
            }
        } else {
            Throw 'One or more status was not found in Halo to update.'
        }
    } catch {
        New-HaloError -ErrorRecord $_
    }
}