diff --git a/CHANGELOG.md b/CHANGELOG.md index c4bc84c..6cca8bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/), and this project adheres to [Semantic Versioning](http://semver.org/). +# [v1.5.x] - 2021-06-08 + +## Piping input + +### New features +Most of "Set" command accepts piped input. Piped objects "id" attribute +is used to select asset set values. Like +Get-SnipeItAsset -model_id 213 | Set-SnipeItAsset -notes 'This is nice!' + +Set command accept id parameter as array, so its easier to set multiple items +in one run. + +Parameter sets. Get commands have now parameters sets.This will make syntax more +clear between search and get by ID use. Use get-help to + +### Fixes +-Empty strings are accepted as input so it's possible to wipe field values if +needed + # [v1.4.x] - 2021-05-27 ## More Activity diff --git a/README.md b/README.md index 7263e6e..62fb243 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,15 @@ Update-Module SnipeitPS # To use each session: Import-Module SnipeitPS -Set-Info -URL 'https://asset.example.com' -apiKey 'tokenKey' +Set-SnipeItInfo -URL 'https://asset.example.com' -apiKey 'tokenKey' ``` ### Usage ```powershell # Review the help at any time! -Get-Help about_SnipeitPS Get-Command -Module SnipeitPS -Get-Help Get-Asset -Full # or any other command +Get-Help Get-SnipeItAsset -Full # or any other command ``` ### Reporting bugs and issues Please use -Verbose switch with command you have problem with. diff --git a/SnipeitPS/Private/Get-ParameterValue.ps1 b/SnipeitPS/Private/Get-ParameterValue.ps1 index 5fb5f4a..afb4039 100644 --- a/SnipeitPS/Private/Get-ParameterValue.ps1 +++ b/SnipeitPS/Private/Get-ParameterValue.ps1 @@ -25,6 +25,8 @@ function Get-ParameterValue { [parameter(mandatory = $true)] $Parameters , + [parameter(mandatory = $true)] + $BoundParameters, [string[]]$DefaultExcludeParameter = @("id", "url", "apiKey", 'Debug', 'Verbose','RequestType','customfields') ) @@ -40,11 +42,16 @@ function Get-ParameterValue { try { $key = $parameter.Key if ($key -notin $DefaultExcludeParameter) { + #Fill in default parameters values if ($null -ne ($value = Get-Variable -Name $key -ValueOnly -ErrorAction Ignore )) { if ($value -ne ($null -as $parameter.Value.ParameterType)) { $ParameterValues[$key] = $value } } + #Fill in all given parameters even empty + if ($BoundParameters.ContainsKey($key)) { + $ParameterValues[$key] = $BoundParameters[$key] + } } } diff --git a/SnipeitPS/Public/Get-SnipeItAccessory.ps1 b/SnipeitPS/Public/Get-SnipeItAccessory.ps1 index 8ac47b9..fbbe131 100644 --- a/SnipeitPS/Public/Get-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAccessory.ps1 @@ -36,25 +36,38 @@ Get-SnipeItAccessory -id 1 function Get-SnipeItAccessory() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get by ID')] + [int]$id, + + [parameter(ParameterSetName='Search')] [int]$company_id, + [parameter(ParameterSetName='Search')] [int]$category_id, + [parameter(ParameterSetName='Search')] [int]$manufacturer_id, + [parameter(ParameterSetName='Search')] [int]$supplier_id, + [parameter(ParameterSetName='Search')] [string]$sort = "created_at", + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -65,7 +78,11 @@ function Get-SnipeItAccessory() { ) Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + if ($id -and $search){ + throw "Please specify only one of -id or -search parameter" + } + + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Parameters = @{ Uri = "$url/api/v1/accessories" @@ -74,6 +91,10 @@ function Get-SnipeItAccessory() { Token = $apiKey } + if($id){ + $Parameters.Uri ="$url/api/v1/accessories/$id" + } + if ($all) { $offstart = $(if($offset){$offset} Else {0}) $callargs = $SearchParameter diff --git a/SnipeitPS/Public/Get-SnipeItActivity.ps1 b/SnipeitPS/Public/Get-SnipeItActivity.ps1 index 1169b4d..ae84259 100644 --- a/SnipeitPS/Public/Get-SnipeItActivity.ps1 +++ b/SnipeitPS/Public/Get-SnipeItActivity.ps1 @@ -88,7 +88,7 @@ function Get-SnipeItActivity() { throw "Please specify both item_type and item_id" } - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Parameters = @{ diff --git a/SnipeitPS/Public/Get-SnipeItAsset.ps1 b/SnipeitPS/Public/Get-SnipeItAsset.ps1 index 40bf01b..069b324 100644 --- a/SnipeitPS/Public/Get-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAsset.ps1 @@ -74,43 +74,63 @@ Get-SnipeItAsset -asset_tag "myAssetTag"-url "https://assets.example.com"-token function Get-SnipeItAsset() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with id')] [int]$id, + [parameter(ParameterSetName='Get with asset tag')] [string]$asset_tag, - [string]$asset_serial, + [parameter(ParameterSetName='Get with serial')] + [Alias('asset_serial')] + [string]$serial, - [int]$order_number, + [parameter(ParameterSetName='Search')] + [string]$order_number, + [parameter(ParameterSetName='Search')] [int]$model_id, + [parameter(ParameterSetName='Search')] [int]$category_id, + [parameter(ParameterSetName='Search')] [int]$manufacturer_id, + [parameter(ParameterSetName='Search')] [int]$company_id, + [parameter(ParameterSetName='Search')] [int]$location_id, + [parameter(ParameterSetName='Search')] [int]$depreciation_id, + [parameter(ParameterSetName='Search')] [bool]$requestable = $false, + [parameter(ParameterSetName='Search')] [string]$status, + [parameter(ParameterSetName='Search')] [int]$status_id, + [parameter(ParameterSetName='Search')] [string]$sort = "created_at", + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] [string]$url, @@ -120,7 +140,7 @@ function Get-SnipeItAsset() { ) Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/hardware" diff --git a/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 b/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 index 602b0c6..b7ee638 100644 --- a/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 +++ b/SnipeitPS/Public/Get-SnipeItAssetMaintenance.ps1 @@ -64,7 +64,7 @@ function Get-SnipeItAssetMaintenance() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Parameters = @{ Uri = "$url/api/v1/maintenances" diff --git a/SnipeitPS/Public/Get-SnipeItCategory.ps1 b/SnipeitPS/Public/Get-SnipeItCategory.ps1 index 827feb5..3aeba40 100644 --- a/SnipeitPS/Public/Get-SnipeItCategory.ps1 +++ b/SnipeitPS/Public/Get-SnipeItCategory.ps1 @@ -34,17 +34,23 @@ Get-SnipeItCategory -search "Laptop" function Get-SnipeItCategory() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -55,7 +61,7 @@ function Get-SnipeItCategory() ) Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/categories" diff --git a/SnipeitPS/Public/Get-SnipeItCompany.ps1 b/SnipeitPS/Public/Get-SnipeItCompany.ps1 index 99748d6..06aa0ad 100644 --- a/SnipeitPS/Public/Get-SnipeItCompany.ps1 +++ b/SnipeitPS/Public/Get-SnipeItCompany.ps1 @@ -35,17 +35,23 @@ Gets specific company function Get-SnipeItCompany() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory=$true)] @@ -57,7 +63,7 @@ function Get-SnipeItCompany() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/companies" diff --git a/SnipeitPS/Public/Get-SnipeItComponent.ps1 b/SnipeitPS/Public/Get-SnipeItComponent.ps1 index 9adb8c1..78c2750 100644 --- a/SnipeitPS/Public/Get-SnipeItComponent.ps1 +++ b/SnipeitPS/Public/Get-SnipeItComponent.ps1 @@ -39,26 +39,36 @@ Returns specific component function Get-SnipeItComponent() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [int]$category_id, + [parameter(ParameterSetName='Search')] [int]$company_id, + [parameter(ParameterSetName='Search')] [int]$location_id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [ValidateSet('id', 'name', 'min_amt', 'order_number', 'serial', 'purchase_date', 'purchase_cost', 'company', 'category', 'qty', 'location', 'image', 'created_at')] [string]$sort = "created_at", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -70,7 +80,7 @@ function Get-SnipeItComponent() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/components" diff --git a/SnipeitPS/Public/Get-SnipeItDepartment.ps1 b/SnipeitPS/Public/Get-SnipeItDepartment.ps1 index b80ec8a..9cb5413 100644 --- a/SnipeitPS/Public/Get-SnipeItDepartment.ps1 +++ b/SnipeitPS/Public/Get-SnipeItDepartment.ps1 @@ -37,19 +37,26 @@ Get-SnipeItDepartment -id 1 function Get-SnipeItDepartment() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, + [parameter(ParameterSetName='Search')] [ValidateSet('id', 'name', 'image', 'users_count', 'created_at')] [string]$sort = "created_at", @@ -62,7 +69,7 @@ function Get-SnipeItDepartment() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/departments" diff --git a/SnipeitPS/Public/Get-SnipeItLicense.ps1 b/SnipeitPS/Public/Get-SnipeItLicense.ps1 index bdca13b..a0ff09a 100644 --- a/SnipeitPS/Public/Get-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/Get-SnipeItLicense.ps1 @@ -34,42 +34,60 @@ Get-SnipeItLicense -id 1 function Get-SnipeItLicense() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [string]$name, + [parameter(ParameterSetName='Search')] [int] $company_id, + [parameter(ParameterSetName='Search')] [string]$product_key, - [int]$order_number, + [parameter(ParameterSetName='Search')] + [string]$order_number, + [parameter(ParameterSetName='Search')] [string]$purchase_order, + [parameter(ParameterSetName='Search')] [string]$license_name, + [parameter(ParameterSetName='Search')] [mailaddress]$license_email, + [parameter(ParameterSetName='Search')] [int]$manufacturer_id, + [parameter(ParameterSetName='Search')] [int]$supplier_id, + [parameter(ParameterSetName='Search')] [int]$depreciation_id, + [parameter(ParameterSetName='Search')] [int]$category_id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [ValidateSet('id', 'name', 'purchase_cost', 'expiration_date', 'purchase_order', 'order_number', 'notes', 'purchase_date', 'serial', 'company', 'category', 'license_name', 'license_email', 'free_seats_count', 'seats', 'manufacturer', 'supplier')] [string]$sort = "created_at", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -81,7 +99,7 @@ function Get-SnipeItLicense() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/licenses" diff --git a/SnipeitPS/Public/Get-SnipeItLicenseSeat.ps1 b/SnipeitPS/Public/Get-SnipeItLicenseSeat.ps1 index 5eef03a..2005d61 100644 --- a/SnipeitPS/Public/Get-SnipeItLicenseSeat.ps1 +++ b/SnipeitPS/Public/Get-SnipeItLicenseSeat.ps1 @@ -56,7 +56,7 @@ function Get-SnipeItLicenseSeat() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/licenses/$id/seats" diff --git a/SnipeitPS/Public/Get-SnipeItLocation.ps1 b/SnipeitPS/Public/Get-SnipeItLocation.ps1 index 718e251..e669da1 100644 --- a/SnipeitPS/Public/Get-SnipeItLocation.ps1 +++ b/SnipeitPS/Public/Get-SnipeItLocation.ps1 @@ -34,17 +34,23 @@ Get-SnipeItLocation -id 3 function Get-SnipeitLocation() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -56,7 +62,7 @@ function Get-SnipeitLocation() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/locations" diff --git a/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 b/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 index 36bcb61..8c465a3 100644 --- a/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 +++ b/SnipeitPS/Public/Get-SnipeItManufacturer.ps1 @@ -36,17 +36,23 @@ Returns manufacturer with id 3 function Get-SnipeItManufacturer() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -58,7 +64,7 @@ function Get-SnipeItManufacturer() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/manufacturers" diff --git a/SnipeitPS/Public/Get-SnipeItModel.ps1 b/SnipeitPS/Public/Get-SnipeItModel.ps1 index 7219657..bc19108 100644 --- a/SnipeitPS/Public/Get-SnipeItModel.ps1 +++ b/SnipeitPS/Public/Get-SnipeItModel.ps1 @@ -34,17 +34,23 @@ Get-SnipeItModel -id 1 function Get-SnipeItModel() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -56,7 +62,7 @@ function Get-SnipeItModel() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/models" diff --git a/SnipeitPS/Public/Get-SnipeItStatus.ps1 b/SnipeitPS/Public/Get-SnipeItStatus.ps1 index ebeb50b..bca89f5 100644 --- a/SnipeitPS/Public/Get-SnipeItStatus.ps1 +++ b/SnipeitPS/Public/Get-SnipeItStatus.ps1 @@ -34,17 +34,23 @@ Get-SnipeItStatus -id 3 function Get-SnipeItStatus() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -56,7 +62,7 @@ function Get-SnipeItStatus() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/statuslabels" diff --git a/SnipeitPS/Public/Get-SnipeItSupplier.ps1 b/SnipeitPS/Public/Get-SnipeItSupplier.ps1 index d5c84fe..84ee531 100644 --- a/SnipeitPS/Public/Get-SnipeItSupplier.ps1 +++ b/SnipeitPS/Public/Get-SnipeItSupplier.ps1 @@ -34,17 +34,23 @@ Get-SnipeItSupplier -id 2 function Get-SnipeItSupplier() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [int]$id, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -56,7 +62,7 @@ function Get-SnipeItSupplier() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/suppliers" diff --git a/SnipeitPS/Public/Get-SnipeItUser.ps1 b/SnipeitPS/Public/Get-SnipeItUser.ps1 index 9f02830..b35f837 100644 --- a/SnipeitPS/Public/Get-SnipeItUser.ps1 +++ b/SnipeitPS/Public/Get-SnipeItUser.ps1 @@ -44,29 +44,41 @@ Get-SnipeItUser -email user@somedomain.com function Get-SnipeItUser() { Param( + [parameter(ParameterSetName='Search')] [string]$search, + [parameter(ParameterSetName='Get with ID')] [string]$id, + [parameter(ParameterSetName='Search')] [int]$company_id, + [parameter(ParameterSetName='Search')] [int]$location_id, + [parameter(ParameterSetName='Search')] [int]$group_id, + [parameter(ParameterSetName='Search')] [int]$department_id, + [parameter(ParameterSetName='Search')] [string]$username, + [parameter(ParameterSetName='Search')] [string]$email, + [parameter(ParameterSetName='Search')] [ValidateSet("asc", "desc")] [string]$order = "desc", + [parameter(ParameterSetName='Search')] [int]$limit = 50, + [parameter(ParameterSetName='Search')] [int]$offset, + [parameter(ParameterSetName='Search')] [switch]$all = $false, [parameter(mandatory = $true)] @@ -78,7 +90,7 @@ function Get-SnipeItUser() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $SearchParameter = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $SearchParameter = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $apiurl = "$url/api/v1/users" diff --git a/SnipeitPS/Public/New-SnipeItAccessory.ps1 b/SnipeitPS/Public/New-SnipeItAccessory.ps1 index 493f628..6a1b1bd 100644 --- a/SnipeitPS/Public/New-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/New-SnipeItAccessory.ps1 @@ -8,6 +8,9 @@ Creates new accessory on Snipe-It system .PARAMETER name Accessory name +.PARAMETER notes +Notes about the accessory + .PARAMETER qty Quantity of the accessory you have @@ -104,7 +107,7 @@ function New-SnipeItAccessory() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['purchase_date']) { $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/New-SnipeItAsset.ps1 b/SnipeitPS/Public/New-SnipeItAsset.ps1 index aea04e8..6a70c29 100644 --- a/SnipeitPS/Public/New-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/New-SnipeItAsset.ps1 @@ -125,7 +125,7 @@ function New-SnipeItAsset() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['purchase_date']) { $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 b/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 index 0f37fd2..9f5ff18 100644 --- a/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 +++ b/SnipeitPS/Public/New-SnipeItAssetMaintenance.ps1 @@ -79,7 +79,7 @@ function New-SnipeItAssetMaintenance() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['start_date']) { $values['start_date'] = $values['start_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/New-SnipeItCompany.ps1 b/SnipeitPS/Public/New-SnipeItCompany.ps1 index c479aeb..349589c 100644 --- a/SnipeitPS/Public/New-SnipeItCompany.ps1 +++ b/SnipeitPS/Public/New-SnipeItCompany.ps1 @@ -39,7 +39,7 @@ function New-SnipeItCompany() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Body = $Values | ConvertTo-Json; diff --git a/SnipeitPS/Public/New-SnipeItComponent.ps1 b/SnipeitPS/Public/New-SnipeItComponent.ps1 index a846332..711b370 100644 --- a/SnipeitPS/Public/New-SnipeItComponent.ps1 +++ b/SnipeitPS/Public/New-SnipeItComponent.ps1 @@ -17,6 +17,9 @@ Quantity of the components you have .PARAMETER location_id ID number of the location the accessory is assigned to +.PARAMETER order_number +Order number of the component + .PARAMETER purchase_date Date accessory was purchased @@ -56,6 +59,8 @@ function New-SnipeItComponent() { [int]$location_id, + [string]$order_number, + [datetime]$purchase_date, [float]$purchase_cost, @@ -69,7 +74,7 @@ function New-SnipeItComponent() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['purchase_date']) { $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/New-SnipeItCustomField.ps1 b/SnipeitPS/Public/New-SnipeItCustomField.ps1 index d4b2d55..ca6c96f 100644 --- a/SnipeitPS/Public/New-SnipeItCustomField.ps1 +++ b/SnipeitPS/Public/New-SnipeItCustomField.ps1 @@ -48,7 +48,7 @@ function New-SnipeItCustomField() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters #Convert Values to JSON format $Body = $Values | ConvertTo-Json; diff --git a/SnipeitPS/Public/New-SnipeItDepartment.ps1 b/SnipeitPS/Public/New-SnipeItDepartment.ps1 index d6141cd..4b2115c 100644 --- a/SnipeitPS/Public/New-SnipeItDepartment.ps1 +++ b/SnipeitPS/Public/New-SnipeItDepartment.ps1 @@ -55,7 +55,7 @@ function New-SnipeItDepartment() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Body = $Values | ConvertTo-Json; diff --git a/SnipeitPS/Public/New-SnipeItLicense.ps1 b/SnipeitPS/Public/New-SnipeItLicense.ps1 index ecfc9df..67cb6fb 100644 --- a/SnipeitPS/Public/New-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/New-SnipeItLicense.ps1 @@ -126,7 +126,7 @@ function New-SnipeItLicense() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['expiration_date']) { $values['expiration_date'] = $values['expiration_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/New-SnipeItLocation.ps1 b/SnipeitPS/Public/New-SnipeItLocation.ps1 index 05a40bd..81ac660 100644 --- a/SnipeitPS/Public/New-SnipeItLocation.ps1 +++ b/SnipeitPS/Public/New-SnipeItLocation.ps1 @@ -87,7 +87,7 @@ function New-SnipeItLocation() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters $Body = $Values | ConvertTo-Json; diff --git a/SnipeitPS/Public/New-SnipeItUser.ps1 b/SnipeitPS/Public/New-SnipeItUser.ps1 index 2dbac25..bab70bd 100644 --- a/SnipeitPS/Public/New-SnipeItUser.ps1 +++ b/SnipeitPS/Public/New-SnipeItUser.ps1 @@ -111,7 +111,7 @@ function New-SnipeItUser() { Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($password ) { $Values['password_confirmation'] = $password diff --git a/SnipeitPS/Public/Set-SnipeItAccessory.ps1 b/SnipeitPS/Public/Set-SnipeItAccessory.ps1 index 668092e..54b9be8 100644 --- a/SnipeitPS/Public/Set-SnipeItAccessory.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAccessory.ps1 @@ -6,7 +6,10 @@ Updates accessory on Snipe-It system Updates accessory on Snipe-It system .PARAMETER name -ID number of Accessory on Snipe-It system +ID number of Accessory or array of IDs on Snipe-It system + +.PARAMETER notes +Notes about the accessory .PARAMETER qty Quantity of the accessory you have @@ -64,8 +67,8 @@ function Set-SnipeItAccessory() { )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [ValidateLength(3, 255)] [string]$name, @@ -81,6 +84,7 @@ function Set-SnipeItAccessory() { [ValidateRange(1, [int]::MaxValue)] [int]$manufacturer_id, + [string]$order_number, [float]$purchase_cost, @@ -99,27 +103,34 @@ function Set-SnipeItAccessory() { [string]$apiKey ) - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + begin { + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - if ($values['purchase_date']) { - $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + if ($values['purchase_date']) { + $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + } + + $Body = $Values | ConvertTo-Json; + Write-Verbose "Body: $Body" + } + + process { + foreach($accessory_id in $id){ + $Parameters = @{ + Uri = "$url/api/v1/accessories/$accessory_id" + Method = 'Patch' + Body = $Body + Token = $apiKey + } + + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } } - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/accessories/$id" - Method = 'POST' - Body = $Body - Token = $apiKey - } - - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { - $result = Invoke-SnipeitMethod @Parameters - } - - $result } diff --git a/SnipeitPS/Public/Set-SnipeItAccessoryOwner.ps1 b/SnipeitPS/Public/Set-SnipeItAccessoryOwner.ps1 index 2602475..4b9d181 100644 --- a/SnipeitPS/Public/Set-SnipeItAccessoryOwner.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAccessoryOwner.ps1 @@ -5,7 +5,7 @@ Checkout accessory to user .PARAMETER id - Unique ID For accessory to checkout + Unique ID For accessory or array of IDs to checkout .PARAMETER assigned_id Id of target user @@ -30,8 +30,8 @@ function Set-SnipeItAccessoryOwner() )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [parameter(mandatory = $true)] [int]$assigned_to, @@ -44,22 +44,27 @@ function Set-SnipeItAccessoryOwner() [parameter(mandatory = $true)] [string]$apiKey ) + begin{ + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/accessories/$id/checkout" - Method = 'POST' - Body = $Body - Token = $apiKey + $Body = $Values | ConvertTo-Json; } - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) - { - $result = Invoke-SnipeitMethod @Parameters - } + process { + foreach($accessory_id in $id){ + $Parameters = @{ + Uri = "$url/api/v1/accessories/$accessory_id/checkout" + Method = 'POST' + Body = $Body + Token = $apiKey + } - return $result + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) + { + $result = Invoke-SnipeitMethod @Parameters + } + + return $result + } + } } diff --git a/SnipeitPS/Public/Set-SnipeItAsset.ps1 b/SnipeitPS/Public/Set-SnipeItAsset.ps1 index d183b15..6cf2ca6 100644 --- a/SnipeitPS/Public/Set-SnipeItAsset.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAsset.ps1 @@ -6,7 +6,7 @@ Long description .PARAMETER id - ID of the Asset + ID of the Asset or array of IDs .PARAMETER Name Asset name @@ -70,6 +70,9 @@ .EXAMPLE Set-SnipeItAsset -id 1 -status_id 1 -model_id 1 -name "Machine1" -CustomValues = @{ "_snipeit_os_5 = "Windows 10 Pro" } + + .EXAMPLE + Get-SnipeItAsset -serial 12345678 | Set-SnipeItAsset -notes 'Just updated' #> function Set-SnipeItAsset() @@ -80,8 +83,9 @@ function Set-SnipeItAsset() )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, + [string]$name, @@ -97,6 +101,7 @@ function Set-SnipeItAsset() [string]$serial, + [string]$order_number, [int]$warranty_months, @@ -124,33 +129,38 @@ function Set-SnipeItAsset() [hashtable] $customfields ) + begin{ + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + if ($values['purchase_date']) { + $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + } - if ($values['purchase_date']) { - $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + if ($customfields) + { + $Values += $customfields + } + + $Body = $Values | ConvertTo-Json; } - if ($customfields) - { - $Values += $customfields + process { + foreach($asset_id in $id){ + $Parameters = @{ + Uri = "$url/api/v1/hardware/$asset_id" + Method = $RequestType + Body = $Body + Token = $apiKey + } + + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) + { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } } - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/hardware/$id" - Method = $RequestType - Body = $Body - Token = $apiKey - } - - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) - { - $result = Invoke-SnipeitMethod @Parameters - } - - $result } diff --git a/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 b/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 index 55193f6..1576457 100644 --- a/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 +++ b/SnipeitPS/Public/Set-SnipeItAssetOwner.ps1 @@ -5,7 +5,7 @@ Checkout asset to user/localtion/asset .PARAMETER ID - Unique ID For asset to checkout + Unique IDs For assets to checkout .PARAMETER assigned_id Id of target user , location or asset @@ -41,8 +41,8 @@ function Set-SnipeItAssetOwner() )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [parameter(mandatory = $true)] [int]$assigned_id, @@ -65,41 +65,48 @@ function Set-SnipeItAssetOwner() [string]$apiKey ) - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + begin{ + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters + + if ($Values['expected_checkin']) { + $Values['expected_checkin'] = $values['expected_checkin'].ToString("yyyy-MM-dd") + } + + if ($Values['checkout_at']) { + $Values['checkout_at'] = $values['checkout_at'].ToString("yyyy-MM-dd") + } + + switch ($checkout_to_type) + { + 'location' { $Values += @{ "assigned_location" = $assigned_id } } + 'user' { $Values += @{ "assigned_user" = $assigned_id } } + 'asset' { $Values += @{ "assigned_asset" = $assigned_id } } + } + + #This can be removed now + if($Values.ContainsKey('assigned_id')){$Values.Remove('assigned_id')} + + $Body = $Values | ConvertTo-Json; - if ($Values['expected_checkin']) { - $Values['expected_checkin'] = $values['expected_checkin'].ToString("yyyy-MM-dd") } - if ($Values['checkout_at']) { - $Values['checkout_at'] = $values['checkout_at'].ToString("yyyy-MM-dd") + process{ + foreach($asset_id in $id){ + $Parameters = @{ + Uri = "$url/api/v1/hardware/$asset_id/checkout" + Method = 'POST' + Body = $Body + Token = $apiKey + } + + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) + { + $result = Invoke-SnipeitMethod @Parameters + } + + return $result + } } - - switch ($checkout_to_type) - { - 'location' { $Values += @{ "assigned_location" = $assigned_id } } - 'user' { $Values += @{ "assigned_user" = $assigned_id } } - 'asset' { $Values += @{ "assigned_asset" = $assigned_id } } - } - - #This can be removed now - if($Values.ContainsKey('assigned_id')){$Values.Remove('assigned_id')} - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/hardware/$id/checkout" - Method = 'POST' - Body = $Body - Token = $apiKey - } - - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) - { - $result = Invoke-SnipeitMethod @Parameters - } - - return $result } diff --git a/SnipeitPS/Public/Set-SnipeItComponents.ps1 b/SnipeitPS/Public/Set-SnipeItComponents.ps1 index bb96414..fb1fe5c 100644 --- a/SnipeitPS/Public/Set-SnipeItComponents.ps1 +++ b/SnipeitPS/Public/Set-SnipeItComponents.ps1 @@ -20,6 +20,9 @@ Quantity of the components you have .PARAMETER location_id ID number of the location the accessory is assigned to +.PARAMETER order_number +Order number for the accessory + .PARAMETER purchase_date Date accessory was purchased @@ -58,6 +61,9 @@ function Set-SnipeItComponent() [int]$location_id, + + [string]$order_number, + [datetime]$purchase_date, [float]$purchase_cost, @@ -71,7 +77,7 @@ function Set-SnipeItComponent() Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters if ($values['purchase_date']) { $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") diff --git a/SnipeitPS/Public/Set-SnipeItLicense.ps1 b/SnipeitPS/Public/Set-SnipeItLicense.ps1 index 3e8dc5e..6471139 100644 --- a/SnipeitPS/Public/Set-SnipeItLicense.ps1 +++ b/SnipeitPS/Public/Set-SnipeItLicense.ps1 @@ -6,7 +6,7 @@ Updates licence on Snipe-It system .PARAMETER id - ID number of licence + ID number of license or array of license IDs .PARAMETER name Name of license @@ -77,8 +77,8 @@ function Set-SnipeItLicense() { )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true, ValueFromPipelineByPropertyName)] + [int[]]$id, [ValidateLength(3, 255)] [string]$name, @@ -107,6 +107,7 @@ function Set-SnipeItLicense() { [string]$notes, + [string]$order_number, [float]$purchase_cost, @@ -128,36 +129,39 @@ function Set-SnipeItLicense() { [parameter(mandatory = $true)] [string]$apiKey ) + begin{ + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + if ($values['expiration_date']) { + $values['expiration_date'] = $values['expiration_date'].ToString("yyyy-MM-dd") + } - if ($values['expiration_date']) { - $values['expiration_date'] = $values['expiration_date'].ToString("yyyy-MM-dd") + if ($values['purchase_date']) { + $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + } + + if ($values['termination_date']) { + $values['termination_date'] = $values['termination_date'].ToString("yyyy-MM-dd") + } + + $Body = $Values | ConvertTo-Json; } + process { + foreach($license_id in $id){ + $Parameters = @{ + Uri = "$url/api/v1/licenses/$license_id" + Method = 'PUT' + Body = $Body + Token = $apiKey + } - if ($values['purchase_date']) { - $values['purchase_date'] = $values['purchase_date'].ToString("yyyy-MM-dd") + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } } - - if ($values['termination_date']) { - $values['termination_date'] = $values['termination_date'].ToString("yyyy-MM-dd") - } - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/licenses/$id" - Method = 'PUT' - Body = $Body - Token = $apiKey - } - - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { - $result = Invoke-SnipeitMethod @Parameters - } - - $result } - diff --git a/SnipeitPS/Public/Set-SnipeItLicenseSeat.ps1 b/SnipeitPS/Public/Set-SnipeItLicenseSeat.ps1 index 3f8c7e8..74154d4 100644 --- a/SnipeitPS/Public/Set-SnipeItLicenseSeat.ps1 +++ b/SnipeitPS/Public/Set-SnipeItLicenseSeat.ps1 @@ -5,7 +5,7 @@ Checkout specific license seat to user, asset or both .PARAMETER ID - Unique ID For asset to checkout + Unique ID For license to checkout or array of IDs .PARAMETER assigned_to Id of target user @@ -40,7 +40,7 @@ function Set-SnipeItLicenseSeat() Param( [parameter(mandatory = $true)] - [int]$id, + [int[]]$id, [parameter(mandatory = $true)] [int]$seat_id, @@ -58,21 +58,27 @@ function Set-SnipeItLicenseSeat() [string]$apiKey ) - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + begin{ + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/licenses/$id/seats/$seat_id" - Method = 'Patch' - Body = $Body - Token = $apiKey + $Body = $Values | ConvertTo-Json; } - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) - { - $result = Invoke-SnipeitMethod @Parameters - } + process{ + foreach($license_id in $id) { + $Parameters = @{ + Uri = "$url/api/v1/licenses/$license_id/seats/$seat_id" + Method = 'Patch' + Body = $Body + Token = $apiKey + } - return $result + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) + { + $result = Invoke-SnipeitMethod @Parameters + } + + return $result + } + } } diff --git a/SnipeitPS/Public/Set-SnipeItLocation.ps1 b/SnipeitPS/Public/Set-SnipeItLocation.ps1 index ab6e4c2..4706742 100644 --- a/SnipeitPS/Public/Set-SnipeItLocation.ps1 +++ b/SnipeitPS/Public/Set-SnipeItLocation.ps1 @@ -5,6 +5,9 @@ .DESCRIPTION Long description + .PARAMETER id + ID number of location or array or IDs + .PARAMETER name Name of Location @@ -59,8 +62,8 @@ function Set-SnipeitLocation() { )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [ValidateLength(3, 255)] [string]$name, @@ -92,23 +95,29 @@ function Set-SnipeitLocation() { [string]$apiKey ) - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + begin{ + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/locations/$id" - Method = 'PUT' - Body = $Body - Token = $apiKey + $Body = $Values | ConvertTo-Json; } - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { - $result = Invoke-SnipeitMethod @Parameters - } + process{ + foreach ($location_id in $id) { + $Parameters = @{ + Uri = "$url/api/v1/locations/$location_id" + Method = 'PUT' + Body = $Body + Token = $apiKey + } - $result + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } + } } diff --git a/SnipeitPS/Public/Set-SnipeItModel.ps1 b/SnipeitPS/Public/Set-SnipeItModel.ps1 index f2c7051..04fc5a1 100644 --- a/SnipeitPS/Public/Set-SnipeItModel.ps1 +++ b/SnipeitPS/Public/Set-SnipeItModel.ps1 @@ -6,7 +6,7 @@ Updates Model on Snipe-it asset system .PARAMETER id - ID number of the Asset Model + ID number of the Asset Model or array of IDs .PARAMETER name Name of the Asset Model @@ -40,13 +40,12 @@ function Set-SnipeItModel() { )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [ValidateLength(1, 255)] [string]$name, - [ValidateLength(1, 255)] [string]$model_number, [int]$category_id, @@ -66,22 +65,27 @@ function Set-SnipeItModel() { [string]$apiKey ) - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + begin { + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/models/$id" - Method = 'put' - Body = $Body - Token = $apiKey + $Body = $Values | ConvertTo-Json; } + process { + foreach ($model_id in $id) { + $Parameters = @{ + Uri = "$url/api/v1/models/$model_id" + Method = 'put' + Body = $Body + Token = $apiKey + } - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { - $result = Invoke-SnipeitMethod @Parameters + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } } - - $result } diff --git a/SnipeitPS/Public/Set-SnipeItUser.ps1 b/SnipeitPS/Public/Set-SnipeItUser.ps1 index 38738a9..26227a5 100644 --- a/SnipeitPS/Public/Set-SnipeItUser.ps1 +++ b/SnipeitPS/Public/Set-SnipeItUser.ps1 @@ -2,6 +2,9 @@ .SYNOPSIS Creates a new user + .PARAMETER id + ID number of Snipe--It user or array of IDs + .DESCRIPTION Creates a new user to Snipe-IT system @@ -68,8 +71,8 @@ function Set-SnipeItUser() { )] Param( - [parameter(mandatory = $true)] - [int]$id, + [parameter(mandatory = $true,ValueFromPipelineByPropertyName)] + [int[]]$id, [string]$first_name, @@ -77,10 +80,13 @@ function Set-SnipeItUser() { [string]$userName, + [string]$jobtitle, + [string]$email, + [string]$phone, [int]$company_id, @@ -91,10 +97,12 @@ function Set-SnipeItUser() { [int]$manager_id, + [string]$employee_num, [bool]$activated, + [string]$notes, [parameter(mandatory = $true)] @@ -103,23 +111,28 @@ function Set-SnipeItUser() { [parameter(mandatory = $true)] [string]$apiKey ) + begin{ + Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name - Test-SnipeItAlias -invocationName $MyInvocation.InvocationName -commandName $MyInvocation.MyCommand.Name + $Values = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters - $Values = . Get-ParameterValue $MyInvocation.MyCommand.Parameters - - $Body = $Values | ConvertTo-Json; - - $Parameters = @{ - Uri = "$url/api/v1/users/$id" - Method = 'PATCH' - Body = $Body - Token = $apiKey + $Body = $Values | ConvertTo-Json; } - If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { - $result = Invoke-SnipeitMethod @Parameters - } + process{ + foreach($user_id in $id) { + $Parameters = @{ + Uri = "$url/api/v1/users/$user_id" + Method = 'PATCH' + Body = $Body + Token = $apiKey + } - $result + If ($PSCmdlet.ShouldProcess("ShouldProcess?")) { + $result = Invoke-SnipeitMethod @Parameters + } + + $result + } + } } diff --git a/SnipeitPS/Public/Update-SnipeItAlias.ps1 b/SnipeitPS/Public/Update-SnipeItAlias.ps1 index 7869b34..50ff7ad 100644 --- a/SnipeitPS/Public/Update-SnipeItAlias.ps1 +++ b/SnipeitPS/Public/Update-SnipeItAlias.ps1 @@ -25,7 +25,7 @@ function Update-SnipeItAlias() param( [Parameter(Mandatory = $true, ValueFromPipeline = $true)] - [AllowEmptyString()] + [string[]] $String ) diff --git a/SnipeitPS/SnipeItPS.psd1 b/SnipeitPS/SnipeItPS.psd1 index ac66eb1..d19eb0b 100644 --- a/SnipeitPS/SnipeItPS.psd1 +++ b/SnipeitPS/SnipeItPS.psd1 @@ -12,7 +12,7 @@ RootModule = 'SnipeItPS' # Version number of this module. -ModuleVersion = '1.4' +ModuleVersion = '1.5' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/appveyor.yml b/appveyor.yml index 78cc948..fe7d763 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,7 +14,7 @@ environment: PSGalleryAPIKey: secure: UdM6qhf5B0G8liHhUrwWERCZr44iSqmg4jUq0lwlTjZs4KyeoiwnBzdej0phqIAm -version: 1.4.{build} +version: 1.5.{build} # Don't rebuild when I tag a release on GitHub skip_tags: true diff --git a/docs/Get-SnipeItAccessory.md b/docs/Get-SnipeItAccessory.md index 259521f..cfc2efd 100644 --- a/docs/Get-SnipeItAccessory.md +++ b/docs/Get-SnipeItAccessory.md @@ -12,10 +12,16 @@ Gets a list of Snipe-it Accessories ## SYNTAX +### Search ``` -Get-SnipeItAccessory [[-search] ] [[-company_id] ] [[-category_id] ] - [[-manufacturer_id] ] [[-supplier_id] ] [[-sort] ] [[-order] ] - [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItAccessory [-search ] [-company_id ] [-category_id ] [-manufacturer_id ] + [-supplier_id ] [-sort ] [-order ] [-limit ] [-offset ] [-all] + -url -apiKey [] +``` + +### Get by ID +``` +Get-SnipeItAccessory [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -40,7 +46,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -59,7 +65,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 11 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -70,11 +76,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -85,11 +91,26 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 2 +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -id +A id of specific Accessory + +```yaml +Type: Int32 +Parameter Sets: Get by ID +Aliases: + +Required: False +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -102,11 +123,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 8 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -117,11 +138,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -132,11 +153,11 @@ Result offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 9 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -147,11 +168,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 7 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -162,11 +183,11 @@ A text string to search the Accessory data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -177,11 +198,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False @@ -192,11 +213,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -211,7 +232,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 10 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItAsset.md b/docs/Get-SnipeItAsset.md index 7828560..b910c01 100644 --- a/docs/Get-SnipeItAsset.md +++ b/docs/Get-SnipeItAsset.md @@ -12,12 +12,27 @@ Gets a list of Snipe-it Assets or specific asset ## SYNTAX +### Search ``` -Get-SnipeItAsset [[-search] ] [[-id] ] [[-asset_tag] ] [[-asset_serial] ] - [[-order_number] ] [[-model_id] ] [[-category_id] ] [[-manufacturer_id] ] - [[-company_id] ] [[-location_id] ] [[-depreciation_id] ] [[-requestable] ] - [[-status] ] [[-status_id] ] [[-sort] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItAsset [-search ] [-order_number ] [-model_id ] [-category_id ] + [-manufacturer_id ] [-company_id ] [-location_id ] [-depreciation_id ] + [-requestable ] [-status ] [-status_id ] [-sort ] [-order ] + [-limit ] [-offset ] [-all] -url -apiKey [] +``` + +### Get with id +``` +Get-SnipeItAsset [-id ] -url -apiKey [] +``` + +### Get with asset tag +``` +Get-SnipeItAsset [-asset_tag ] -url -apiKey [] +``` + +### Get with serial +``` +Get-SnipeItAsset [-serial ] -url -apiKey [] ``` ## DESCRIPTION @@ -52,7 +67,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -71,22 +86,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 20 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -asset_serial -Exact asset serialnumber to query - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -97,11 +97,11 @@ Exact asset tag to query ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get with asset tag Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -112,11 +112,11 @@ Optionally restrict asset results to this category ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 7 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -127,11 +127,11 @@ Optionally restrict asset results to this company ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 9 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -142,11 +142,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 11 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -157,11 +157,11 @@ ID number of excact snipeit asset ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with id Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -174,11 +174,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 17 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -189,11 +189,11 @@ Optionally restrict asset results to this location ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 10 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -204,11 +204,11 @@ Optionally restrict asset results to this manufacturer ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 8 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -219,11 +219,11 @@ Optionally restrict asset results to this asset model ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -234,11 +234,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 18 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -249,11 +249,11 @@ Specify the order (asc or desc) you wish to order by on your sort column ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 16 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -263,12 +263,12 @@ Accept wildcard characters: False Optionally restrict asset results to this order number ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -279,11 +279,11 @@ Accept wildcard characters: False ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 12 +Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False @@ -294,11 +294,26 @@ A text string to search the assets data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -serial +{{ Fill serial Description }} + +```yaml +Type: String +Parameter Sets: Get with serial +Aliases: asset_serial + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -309,11 +324,11 @@ Specify the column name you wish to sort by ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 15 +Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False @@ -324,11 +339,11 @@ Optionally restrict asset results to one of these status types: RTD, Deployed, U ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 13 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -339,11 +354,11 @@ Optionally restrict asset results to this status label ID ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 14 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -358,7 +373,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 19 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItCategory.md b/docs/Get-SnipeItCategory.md index b66f781..91a9992 100644 --- a/docs/Get-SnipeItCategory.md +++ b/docs/Get-SnipeItCategory.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Categories ## SYNTAX +### Search ``` -Get-SnipeItCategory [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItCategory [-search ] [-order ] [-limit ] [-offset ] [-all] + -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItCategory [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -39,7 +45,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -58,7 +64,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,11 +75,11 @@ A id of specific Category ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +92,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -101,11 +107,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -116,11 +122,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +137,11 @@ A text string to search the Categories data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItCompany.md b/docs/Get-SnipeItCompany.md index 661a24f..b6e63a9 100644 --- a/docs/Get-SnipeItCompany.md +++ b/docs/Get-SnipeItCompany.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Companies ## SYNTAX +### Search ``` -Get-SnipeItCompany [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItCompany [-search ] [-order ] [-limit ] [-offset ] [-all] -url + -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItCompany [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -41,7 +47,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -60,7 +66,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -71,11 +77,11 @@ A id of specific Company ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -88,11 +94,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -103,11 +109,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -118,11 +124,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -133,11 +139,11 @@ A text string to search the Companies data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -152,7 +158,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItComponent.md b/docs/Get-SnipeItComponent.md index 81dcfbc..1354ddc 100644 --- a/docs/Get-SnipeItComponent.md +++ b/docs/Get-SnipeItComponent.md @@ -12,10 +12,16 @@ Gets a list of Snipe-it Components ## SYNTAX +### Search ``` -Get-SnipeItComponent [[-search] ] [[-id] ] [[-category_id] ] [[-company_id] ] - [[-location_id] ] [[-order] ] [[-sort] ] [[-limit] ] [[-offset] ] [-all] - [-url] [-apiKey] [] +Get-SnipeItComponent [-search ] [-category_id ] [-company_id ] [-location_id ] + [-order ] [-sort ] [-limit ] [-offset ] [-all] -url -apiKey + [] +``` + +### Get with ID +``` +Get-SnipeItComponent [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -48,7 +54,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -67,7 +73,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 11 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -78,11 +84,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -93,11 +99,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -108,11 +114,11 @@ A id of specific Component ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -125,11 +131,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 8 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -140,11 +146,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -155,11 +161,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 9 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -170,11 +176,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -185,11 +191,11 @@ A text string to search the Components data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -200,11 +206,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 7 +Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False @@ -219,7 +225,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 10 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItDepartment.md b/docs/Get-SnipeItDepartment.md index 1572f9f..b1774d4 100644 --- a/docs/Get-SnipeItDepartment.md +++ b/docs/Get-SnipeItDepartment.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Departments ## SYNTAX +### Search ``` -Get-SnipeItDepartment [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [[-sort] ] [-url] [-apiKey] [] +Get-SnipeItDepartment [-search ] [-order ] [-limit ] [-offset ] [-all] + [-sort ] -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItDepartment [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -44,7 +50,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -63,7 +69,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 8 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,11 +80,11 @@ A id of specific Department ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -91,11 +97,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -106,11 +112,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -121,11 +127,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -136,11 +142,11 @@ A text string to search the Departments data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -151,11 +157,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False @@ -170,7 +176,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItLicense.md b/docs/Get-SnipeItLicense.md index 7be41ae..605a65f 100644 --- a/docs/Get-SnipeItLicense.md +++ b/docs/Get-SnipeItLicense.md @@ -12,12 +12,18 @@ Gets a list of Snipe-it Licenses ## SYNTAX +### Search ``` -Get-SnipeItLicense [[-search] ] [[-id] ] [[-name] ] [[-company_id] ] - [[-product_key] ] [[-order_number] ] [[-purchase_order] ] [[-license_name] ] - [[-license_email] ] [[-manufacturer_id] ] [[-supplier_id] ] - [[-depreciation_id] ] [[-category_id] ] [[-order] ] [[-sort] ] - [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItLicense [-search ] [-name ] [-company_id ] [-product_key ] + [-order_number ] [-purchase_order ] [-license_name ] [-license_email ] + [-manufacturer_id ] [-supplier_id ] [-depreciation_id ] [-category_id ] + [-order ] [-sort ] [-limit ] [-offset ] [-all] -url -apiKey + [] +``` + +### Get with ID +``` +Get-SnipeItLicense [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -42,7 +48,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -61,7 +67,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 19 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -72,11 +78,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 13 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -87,11 +93,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -102,11 +108,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 12 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -117,11 +123,11 @@ A id of specific License ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -132,11 +138,11 @@ Accept wildcard characters: False ```yaml Type: MailAddress -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 9 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -147,11 +153,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 8 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,11 +170,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 16 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -179,11 +185,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 10 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -194,11 +200,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -209,11 +215,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 17 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -224,11 +230,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 14 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -238,12 +244,12 @@ Accept wildcard characters: False {{ Fill order_number Description }} ```yaml -Type: Int32 -Parameter Sets: (All) +Type: String +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -254,11 +260,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -269,11 +275,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -284,11 +290,11 @@ A text string to search the Licenses data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -299,11 +305,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 15 +Position: Named Default value: Created_at Accept pipeline input: False Accept wildcard characters: False @@ -314,11 +320,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 11 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -333,7 +339,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 18 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItManufacturer.md b/docs/Get-SnipeItManufacturer.md index 897a3f3..33ab2fb 100644 --- a/docs/Get-SnipeItManufacturer.md +++ b/docs/Get-SnipeItManufacturer.md @@ -12,9 +12,15 @@ schema: 2.0.0 ## SYNTAX +### Search ``` -Get-SnipeItManufacturer [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItManufacturer [-search ] [-order ] [-limit ] [-offset ] [-all] + -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItManufacturer [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -41,7 +47,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -60,7 +66,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -71,11 +77,11 @@ A id of specific Manufactuter ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -88,11 +94,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -103,11 +109,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -118,11 +124,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -133,11 +139,11 @@ A text string to search the Manufactures data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -152,7 +158,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItModel.md b/docs/Get-SnipeItModel.md index 6c74880..07e36e7 100644 --- a/docs/Get-SnipeItModel.md +++ b/docs/Get-SnipeItModel.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Models ## SYNTAX +### Search ``` -Get-SnipeItModel [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItModel [-search ] [-order ] [-limit ] [-offset ] [-all] -url + -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItModel [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -39,7 +45,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -58,7 +64,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,11 +75,11 @@ A id of specific model ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +92,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -101,11 +107,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -116,11 +122,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +137,11 @@ A text string to search the Models data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItStatus.md b/docs/Get-SnipeItStatus.md index a08bd6d..369cdc3 100644 --- a/docs/Get-SnipeItStatus.md +++ b/docs/Get-SnipeItStatus.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Status Labels ## SYNTAX +### Search ``` -Get-SnipeItStatus [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItStatus [-search ] [-order ] [-limit ] [-offset ] [-all] -url + -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItStatus [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -39,7 +45,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -58,7 +64,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,11 +75,11 @@ A id of specific Status Label ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +92,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -101,11 +107,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -116,11 +122,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +137,11 @@ A text string to search the Status Labels data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItSupplier.md b/docs/Get-SnipeItSupplier.md index 0413493..77bd4a9 100644 --- a/docs/Get-SnipeItSupplier.md +++ b/docs/Get-SnipeItSupplier.md @@ -12,9 +12,15 @@ schema: 2.0.0 ## SYNTAX +### Search ``` -Get-SnipeItSupplier [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeItSupplier [-search ] [-order ] [-limit ] [-offset ] [-all] + -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItSupplier [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -39,7 +45,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -58,7 +64,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,11 +75,11 @@ A id of specific Suplier ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +92,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -101,11 +107,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -116,11 +122,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +137,11 @@ A text string to search the Supliers data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeItUser.md b/docs/Get-SnipeItUser.md index 7d643f4..cfbb130 100644 --- a/docs/Get-SnipeItUser.md +++ b/docs/Get-SnipeItUser.md @@ -12,11 +12,16 @@ schema: 2.0.0 ## SYNTAX +### Search ``` -Get-SnipeItUser [[-search] ] [[-id] ] [[-company_id] ] [[-location_id] ] - [[-group_id] ] [[-department_id] ] [[-username] ] [[-email] ] - [[-order] ] [[-limit] ] [[-offset] ] [-all] [-url] [-apiKey] - [] +Get-SnipeItUser [-search ] [-company_id ] [-location_id ] [-group_id ] + [-department_id ] [-username ] [-email ] [-order ] [-limit ] + [-offset ] [-all] -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeItUser [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -51,7 +56,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -70,7 +75,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 13 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -81,11 +86,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -96,11 +101,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 6 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -111,11 +116,11 @@ Search string for email field ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 8 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -126,11 +131,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -141,11 +146,11 @@ A id of specific User ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -158,11 +163,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 10 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -173,11 +178,11 @@ Accept wildcard characters: False ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -188,11 +193,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 11 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -203,11 +208,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 9 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -218,11 +223,11 @@ A text string to search the User data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -237,7 +242,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 12 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -248,11 +253,11 @@ Search string for username field ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Get-SnipeitLocation.md b/docs/Get-SnipeitLocation.md index 2c7ed5b..01a6808 100644 --- a/docs/Get-SnipeitLocation.md +++ b/docs/Get-SnipeitLocation.md @@ -12,9 +12,15 @@ Gets a list of Snipe-it Locations ## SYNTAX +### Search ``` -Get-SnipeitLocation [[-search] ] [[-id] ] [[-order] ] [[-limit] ] - [[-offset] ] [-all] [-url] [-apiKey] [] +Get-SnipeitLocation [-search ] [-order ] [-limit ] [-offset ] [-all] + -url -apiKey [] +``` + +### Get with ID +``` +Get-SnipeitLocation [-id ] -url -apiKey [] ``` ## DESCRIPTION @@ -39,7 +45,7 @@ A return all results, works with -offset and other parameters ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False @@ -58,7 +64,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 7 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -69,11 +75,11 @@ A id of specific Location ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Get with ID Aliases: Required: False -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -86,11 +92,11 @@ Defines batch size for -all ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 4 +Position: Named Default value: 50 Accept pipeline input: False Accept wildcard characters: False @@ -101,11 +107,11 @@ Offset to use ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 5 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -116,11 +122,11 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 3 +Position: Named Default value: Desc Accept pipeline input: False Accept wildcard characters: False @@ -131,11 +137,11 @@ A text string to search the Locations data ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Search Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 6 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/New-SnipeItComponent.md b/docs/New-SnipeItComponent.md index 2292692..3e1b3c0 100644 --- a/docs/New-SnipeItComponent.md +++ b/docs/New-SnipeItComponent.md @@ -14,8 +14,8 @@ Create a new component ``` New-SnipeItComponent [-name] [-category_id] [-qty] [[-company_id] ] - [[-location_id] ] [[-purchase_date] ] [[-purchase_cost] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-location_id] ] [[-order_number] ] [[-purchase_date] ] [[-purchase_cost] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,7 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 9 +Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,6 +105,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -order_number +Order number of the component + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -purchase_cost Cost of item being purchased. @@ -114,7 +129,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 7 +Position: 8 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -129,7 +144,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,7 +174,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 8 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Set-SnipeItAccessory.md b/docs/Set-SnipeItAccessory.md index 3b10b76..ba356e5 100644 --- a/docs/Set-SnipeItAccessory.md +++ b/docs/Set-SnipeItAccessory.md @@ -13,7 +13,7 @@ Updates accessory on Snipe-It system ## SYNTAX ``` -Set-SnipeItAccessory [-id] [[-name] ] [[-qty] ] [[-category_id] ] +Set-SnipeItAccessory [-id] [[-name] ] [[-qty] ] [[-category_id] ] [[-company_id] ] [[-manufacturer_id] ] [[-order_number] ] [[-purchase_cost] ] [[-purchase_date] ] [[-min_qty] ] [[-supplier_id] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] @@ -80,14 +80,14 @@ Accept wildcard characters: False {{ Fill id Description }} ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItAccessoryOwner.md b/docs/Set-SnipeItAccessoryOwner.md index 98da95c..073cf57 100644 --- a/docs/Set-SnipeItAccessoryOwner.md +++ b/docs/Set-SnipeItAccessoryOwner.md @@ -13,7 +13,7 @@ Checkout accessory ## SYNTAX ``` -Set-SnipeItAccessoryOwner [-id] [-assigned_to] [[-note] ] [-url] +Set-SnipeItAccessoryOwner [-id] [-assigned_to] [[-note] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` @@ -63,14 +63,14 @@ Accept wildcard characters: False Unique ID For accessory to checkout ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItAsset.md b/docs/Set-SnipeItAsset.md index 831e7f4..9de0a17 100644 --- a/docs/Set-SnipeItAsset.md +++ b/docs/Set-SnipeItAsset.md @@ -13,7 +13,7 @@ Update a specific Asset in the Snipe-it asset system ## SYNTAX ``` -Set-SnipeItAsset [-id] [[-name] ] [[-status_id] ] [[-model_id] ] +Set-SnipeItAsset [-id] [[-name] ] [[-status_id] ] [[-model_id] ] [[-last_checkout] ] [[-assigned_to] ] [[-company_id] ] [[-serial] ] [[-order_number] ] [[-warranty_months] ] [[-purchase_cost] ] [[-purchase_date] ] [[-requestable] ] [[-archived] ] [[-rtd_location_id] ] @@ -118,14 +118,14 @@ Accept wildcard characters: False ID of the Asset ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItAssetOwner.md b/docs/Set-SnipeItAssetOwner.md index 3b87adb..96826cd 100644 --- a/docs/Set-SnipeItAssetOwner.md +++ b/docs/Set-SnipeItAssetOwner.md @@ -13,7 +13,7 @@ Checkout asset ## SYNTAX ``` -Set-SnipeItAssetOwner [-id] [-assigned_id] [[-checkout_to_type] ] [[-name] ] +Set-SnipeItAssetOwner [-id] [-assigned_id] [[-checkout_to_type] ] [[-name] ] [[-note] ] [[-expected_checkin] ] [[-checkout_at] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` @@ -109,14 +109,14 @@ Accept wildcard characters: False Unique ID For asset to checkout ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItComponent.md b/docs/Set-SnipeItComponent.md index 6ccc875..9bd6476 100644 --- a/docs/Set-SnipeItComponent.md +++ b/docs/Set-SnipeItComponent.md @@ -14,8 +14,8 @@ Updates component ``` Set-SnipeItComponent [-id] [-qty] [[-name] ] [[-company_id] ] - [[-location_id] ] [[-purchase_date] ] [[-purchase_cost] ] [-url] - [-apiKey] [-WhatIf] [-Confirm] [] + [[-location_id] ] [[-order_number] ] [[-purchase_date] ] [[-purchase_cost] ] + [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,7 +39,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 9 +Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -105,6 +105,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -order_number +Order number for the accessory + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -purchase_cost Cost of item being purchased. @@ -114,7 +129,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 7 +Position: 8 Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -129,7 +144,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 6 +Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -159,7 +174,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 8 +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/docs/Set-SnipeItLicense.md b/docs/Set-SnipeItLicense.md index 8dfa8cc..9a03542 100644 --- a/docs/Set-SnipeItLicense.md +++ b/docs/Set-SnipeItLicense.md @@ -13,7 +13,7 @@ Updates a licence ## SYNTAX ``` -Set-SnipeItLicense [-id] [[-name] ] [[-seats] ] [[-category_id] ] +Set-SnipeItLicense [-id] [[-name] ] [[-seats] ] [[-category_id] ] [[-company_id] ] [[-expiration_date] ] [[-license_email] ] [[-license_name] ] [[-maintained] ] [[-manufacturer_id] ] [[-notes] ] [[-order_number] ] [[-purchase_cost] ] [[-purchase_date] ] @@ -97,14 +97,14 @@ Accept wildcard characters: False ID number of licence ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItLicenseSeat.md b/docs/Set-SnipeItLicenseSeat.md index 305ef41..329bda2 100644 --- a/docs/Set-SnipeItLicenseSeat.md +++ b/docs/Set-SnipeItLicenseSeat.md @@ -13,7 +13,7 @@ Set license seat or checkout license seat ## SYNTAX ``` -Set-SnipeItLicenseSeat [-id] [-seat_id] [[-assigned_id] ] [[-asset_id] ] +Set-SnipeItLicenseSeat [-id] [-seat_id] [[-assigned_id] ] [[-asset_id] ] [[-note] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` @@ -85,7 +85,7 @@ Accept wildcard characters: False Unique ID For asset to checkout ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: diff --git a/docs/Set-SnipeItModel.md b/docs/Set-SnipeItModel.md index 816f4e0..52fddfe 100644 --- a/docs/Set-SnipeItModel.md +++ b/docs/Set-SnipeItModel.md @@ -13,7 +13,7 @@ Updates Model on Snipe-it asset system ## SYNTAX ``` -Set-SnipeItModel [-id] [[-name] ] [[-model_number] ] [[-category_id] ] +Set-SnipeItModel [-id] [[-name] ] [[-model_number] ] [[-category_id] ] [[-manufacturer_id] ] [[-eol] ] [[-custom_fieldset_id] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] ``` @@ -94,14 +94,14 @@ Accept wildcard characters: False ID number of the Asset Model ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeItUser.md b/docs/Set-SnipeItUser.md index 4fb2642..6bf8467 100644 --- a/docs/Set-SnipeItUser.md +++ b/docs/Set-SnipeItUser.md @@ -13,7 +13,7 @@ Creates a new user ## SYNTAX ``` -Set-SnipeItUser [-id] [[-first_name] ] [[-last_name] ] [[-userName] ] +Set-SnipeItUser [-id] [[-first_name] ] [[-last_name] ] [[-userName] ] [[-jobtitle] ] [[-email] ] [[-phone] ] [[-company_id] ] [[-location_id] ] [[-department_id] ] [[-manager_id] ] [[-employee_num] ] [[-activated] ] [[-notes] ] [-url] [-apiKey] [-WhatIf] [-Confirm] @@ -142,14 +142,14 @@ Accept wildcard characters: False {{ Fill id Description }} ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/docs/Set-SnipeitLocation.md b/docs/Set-SnipeitLocation.md index 0a8b335..6b0f884 100644 --- a/docs/Set-SnipeitLocation.md +++ b/docs/Set-SnipeitLocation.md @@ -13,7 +13,7 @@ Updates Location in Snipe-it asset system ## SYNTAX ``` -Set-SnipeitLocation [-id] [[-name] ] [[-address] ] [[-address2] ] +Set-SnipeitLocation [-id] [[-name] ] [[-address] ] [[-address2] ] [[-state] ] [[-country] ] [[-zip] ] [[-city] ] [[-currency] ] [[-manager_id] ] [[-ldap_ou] ] [[-parent_id] ] [-url] [-apiKey] [-WhatIf] [-Confirm] [] @@ -125,14 +125,14 @@ Accept wildcard characters: False {{ Fill id Description }} ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```