Public/Teams.ps1

function Get-TMTeam {
    <#
    .SYNOPSIS
    Retrieves one or more Teams from TransitionManager
 
    .DESCRIPTION
    This function will retrieve one or more Teams from TransitonManager,
    optionally filtering by Code or Description
 
    .PARAMETER TMSession
    The name of the TM Session to use when retrieving Teams
 
    .PARAMETER Code
    One or more Team codes to filter by
 
    .PARAMETER Description
    One or more Team descriptions to filter by
 
    .EXAMPLE
    Get-TMTeam -TMSession TMAD60 -Description 'System*'
 
    .EXAMPLE
    Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN', 'AUTO'
 
    .OUTPUTS
    A list of TMTeam objects
    #>


    [CmdletBinding(DefaultParameterSetName = 'All')]
    param (
        [Parameter(Mandatory = $false, Position = 0)]
        [PSObject]$TMSession = "Default",

        [Parameter(Mandatory = $false, ParameterSetName = 'ByCode')]
        [ValidateLength(1, 32)]
        [String[]]$Code,

        [Parameter(Mandatory = $false, ParameterSetName = 'ByDescription')]
        [String[]]$Description
    )

    # Get the session configuration
    Write-Verbose "Checking for cached TMSession"
    $TMSession = Get-TMSession $TMSession
    Write-Debug "TMSessionConfig:"
    Write-Debug ($TMSession | ConvertTo-Json -Depth 5)
    if (-not $TMSession) {
        throw "TMSession '$TMSession' not found. Use New-TMSession command before using features."
    }

    $Teams = [System.Collections.Generic.List[TMTeam]]::new()
    try {
        Write-Verbose "Forming web request parameters"
        $WebRequestSplat = @{
            Uri        = "https://$($TMSession.TMServer)/tdstm/ws/team/list"
            WebSession = $TMSession.TMWebSession
            Method     = 'GET'
        }
        Write-Debug "Web Request Parameters:"
        Write-Debug ($WebRequestSplat | ConvertTo-Json -Depth 10)
        Write-Verbose "Invoking web request"
        $Response = Invoke-WebRequest @WebRequestSplat
        Write-Debug "Response Content:"
        Write-Debug ($Response.Content | ConvertTo-Json)
        if ($Response.StatusCode -in 200, 204) {
            ($Response.Content | ConvertFrom-Json).data | ForEach-Object {
                $Teams.Add([TMTeam]::new($_))
            }
        }
    } catch {
        throw "Error when gettting Teams: $($_.Exception.Message)"
    }

    ## Sort the Teams
    $Teams = $Teams | Sort-Object -Property 'CODE'

    if ($PSCmdlet.ParameterSetName -eq 'ByCode') {
        foreach ($Item in $Code) {
            $Teams | Where-Object { $_.Code -match $Item }
        }
    } elseif ($PSCmdlet.ParameterSetName -eq 'ByDescription') {
        foreach ($Item in $Description) {
            $Teams | Where-Object { $_.Description -like $Item }
        }
    } else {
        $Teams
    }
}


function New-TMTeam {
    <#
    .SYNOPSIS
    Creates a Team in TransitionManager
 
    .DESCRIPTION
    This function will create a new Team in TransitionManager using the specified properties
 
    .PARAMETER TMSession
    The name of the TM Session to use when creating a Team
 
    .PARAMETER Code
    The Code to use for the new Team
 
    .PARAMETER Description
    The description of the new Team
 
    .PARAMETER Level
    The level of the new Team
 
    .PARAMETER Help
    The help text for the new Team
 
    .EXAMPLE
    New-TMTeam -TMSession TMAD60 -Code 'TEST_TEAM2' -Description 'Test Team 2' -Help 'This is the second test team'
 
    .EXAMPLE
    Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN', 'AUTO' | ForEach-Object {
    $_.Code += "2"
    $_.Description += "2"
    $_
    } | New-TMTeam -TMSession TMAD60
 
    .OUTPUTS
    None
    #>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false, Position = 1)]
        [PSObject]$TMSession = "Default",

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [ValidateLength(1, 32)]
        [String]$Code,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [String]$Description,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [ValidateRange(0, 100)]
        [Int]$Level = 0,

        [Parameter(Mandatory = $false, ValueFromPipelineByPropertyName = $true)]
        [String]$Help
    )


    begin {
        # Get the session configuration
        Write-Verbose "Checking for cached TMSession"
        $TMSession = Get-TMSession $TMSession
        Write-Debug "TMSessionConfig:"
        Write-Debug ($TMSession | ConvertTo-Json -Depth 5)
        if (-not $TMSession) {
            throw "TMSession '$TMSession' not found. Use New-TMSession command before using features."
        }
    }

    process {
        try {
            $WebRequestSplat = @{
                Uri                  = "https://$($TMSession.TMServer)/tdstm/ws/team"
                WebSession           = $TMSession.TMWebSession
                SkipCertificateCheck = $TMSession.AllowInsecureSSL
                Method               = 'POST'
                Body                 = (@{
                        id          = $Code
                        help        = $Help
                        description = $Description
                        level       = $Level
                        prevId      = ""
                    } | ConvertTo-Json -Compress)
            }
            $Response = Invoke-WebRequest @WebRequestSplat
            if ($Response.StatusCode -notin 200, 204) {
                throw "The status code $($Response.StatusCode) does not indicate success"
            }
        } catch {
            throw "Error when creating Team: $($_.Exception.Message)"
        }
    }
}


function Update-TMTeam {
    <#
    .SYNOPSIS
    Updates a Team in TransitionManager
 
    .DESCRIPTION
    This function will update the Description and/or Help text on a Team record in TransitionManager
 
    .PARAMETER TMSession
    The name of the TM Session to use when updating a Team
 
    .PARAMETER Team
    A TMTeam object representing the Updates required on the Team
 
    .PARAMETER Code
    The Code of the Team to update
 
    .PARAMETER Description
    The Description to place on the Team record
 
    .PARAMETER Help
    The Help text to place on the Team record
 
    .EXAMPLE
    Update-TMTeam -TMSession TMAD60 -Code 'DB_ADMIN' -Description 'Database Administrator' -Help "Whatever"
 
    .EXAMPLE
    $Team = Get-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN'
    $Team.Help = 'System Administrator'
    Update-TMTeam -TMSession TMAD60 -Team $Team
 
    .OUTPUTS
    None
    #>


    [CmdletBinding(DefaultParameterSetName = 'ByProperty')]
    param (
        [Parameter(Mandatory = $false, Position = 1)]
        [PSObject]$TMSession = "Default",

        [Parameter(Mandatory = $true, ParameterSetName = 'ByObject')]
        [Alias('InputObject')]
        [TMTeam]$Team,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')]
        [ValidateLength(1, 32)]
        [String]$Code,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')]
        [String]$Description,

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true, ParameterSetName = 'ByProperty')]
        [String]$Help
    )


    begin {
        # Get the session configuration
        Write-Verbose "Checking for cached TMSession"
        $TMSession = Get-TMSession $TMSession
        Write-Debug "TMSessionConfig:"
        Write-Debug ($TMSession | ConvertTo-Json -Depth 5)
        if (-not $TMSession) {
            throw "TMSession '$TMSession' not found. Use New-TMSession command before using features."
        }
    }

    process {
        try {
            $WebRequestSplat = @{
                Uri        = "https://$($TMSession.TMServer)/tdstm/ws/team/$([System.Web.HttpUtility]::UrlEncode($Code))"
                WebSession = $TMSession.TMWebSession
                Method     = 'PUT'
                Body       = (@{
                        prevId      = $Code
                        description = $Description
                        help        = $Help
                    } | ConvertTo-Json -Compress)
            }
            $Response = Invoke-WebRequest @WebRequestSplat
            if ($Response.StatusCode -notin 200, 204) {
                throw "The status code $($Response.StatusCode) does not indicate success"
            }
        } catch {
            throw "Error when updating Team: $($_.Exception.Message)"
        }
    }
}
Set-Alias -Name 'Set-TMTeam' -Value 'Update-TMTeam'


function Remove-TMTeam {
    <#
    .SYNOPSIS
    Deletes a Team record from TransitionManager
 
    .DESCRIPTION
    This function will delete the specified Team record from TransitionManager
 
    .PARAMETER TMSession
    The name of the TM Session to use when removing a Team
 
    .PARAMETER Code
    The Code of the Team to delete
 
    .EXAMPLE
    Get-TMTeam -TMSession TMAD60 -Code 'AUTO*' | Remove-TMTeam -TMSession TMAD60
 
    .EXAMPLE
    Remove-TMTeam -TMSession TMAD60 -Code 'SYS_ADMIN'
 
    .OUTPUTS
    None
    #>


    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $false, Position = 1)]
        [PSObject]$TMSession = "Default",

        [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)]
        [ValidateLength(1, 32)]
        [String]$Code
    )


    begin {
        # Get the session configuration
        Write-Verbose "Checking for cached TMSession"
        $TMSession = Get-TMSession $TMSession
        Write-Debug "TMSessionConfig:"
        Write-Debug ($TMSession | ConvertTo-Json -Depth 5)
        if (-not $TMSession) {
            throw "TMSession '$TMSession' not found. Use New-TMSession command before using features."
        }
    }

    process {
        try {
            $WebRequestSplat = @{
                Uri        = "https://$($TMSession.TMServer)/tdstm/ws/team/$([System.Web.HttpUtility]::UrlEncode($Code))"
                WebSession = $TMSession.TMWebSession
                Method     = 'DELETE'
            }
            $Response = Invoke-WebRequest @WebRequestSplat
            if ($Response.StatusCode -notin 200, 204) {
                throw "The status code $($Response.StatusCode) does not indicate success"
            }
        } catch {
            throw "Error when gettting Teams: $($_.Exception.Message)"
        }
    }
}