Public/Set-SnipeitCategory.ps1
|
<# .SYNOPSIS Create a new Snipe-IT Category .PARAMETER name Name of new category to be created .PARAMETER type Type of new category to be created (asset, accessory, consumable, component, license) .PARAMETER use_default_eula If switch is present, use the primary default EULA .PARAMETER eula_text This allows you to customize your EULAs for specific types of assets .PARAMETER require_acceptance If switch is present, require users to confirm acceptance of assets in this category .PARAMETER checkin_email Should the user be emailed the EULA and/or an acceptance confirmation email when this item is checked in? .PARAMETER image Image file name and path for item .PARAMETER image_delete Remove current image .PARAMETER RequestType Http request type to send Snipe IT system. Defaults to Patch you could use Put if needed. .PARAMETER url Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system. .PARAMETER apiKey Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key API Key for Snipeit. .EXAMPLE Set-SnipeitCategory -id 4 -name "Laptops" #> function Set-SnipeitCategory() { [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = "Low" )] Param( [parameter(mandatory = $true)] [int[]]$id, [string]$name, [ValidateSet("asset", "accessory", "consumable", "component", "license")] [string]$category_type, [string]$eula_text, [bool]$use_default_eula, [bool]$require_acceptance, [bool]$checkin_email, [ValidateScript({Test-Path $_})] [string]$image, [switch]$image_delete=$false, [ValidateSet("Put","Patch")] [string]$RequestType = "Patch", [parameter(mandatory = $false)] [string]$url, [parameter(mandatory = $false)] [string]$apiKey ) begin { Test-SnipeitAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters } process { foreach($category_id in $id) { $Parameters = @{ Api = "/api/v1/categories/$category_id" Method = $RequestType Body = $values } if ($PSBoundParameters.ContainsKey('apiKey') -and '' -ne [string]$apiKey) { Write-Warning "-apiKey parameter is deprecated, please use Connect-SnipeitPS instead." Set-SnipeitPSLegacyApiKey -apiKey $apikey } if ($PSBoundParameters.ContainsKey('url') -and '' -ne [string]$url) { Write-Warning "-url parameter is deprecated, please use Connect-SnipeitPS instead." Set-SnipeitPSLegacyUrl -url $url } if ($PSCmdlet.ShouldProcess("ShouldProcess?")) { $result = Invoke-SnipeitMethod @Parameters } $result } } end { # reset legacy sessions if ($PSBoundParameters.ContainsKey('url') -and '' -ne [string]$url -or $PSBoundParameters.ContainsKey('apiKey') -and '' -ne [string]$apiKey) { Reset-SnipeitPSLegacyApi } } } |