Dynamic/New-AtwsContractRetainer.ps1
|
#Requires -Version 4.0 <# .COPYRIGHT Copyright (c) Office Center Hønefoss AS. All rights reserved. Based on code from Jan Egil Ring (Crayon). Licensed under the MIT license. See https://github.com/officecenter/Autotask/blob/master/LICENSE.md for license information. #> Function New-AtwsContractRetainer { <# .SYNOPSIS This function creates a new ContractRetainer through the Autotask Web Services API. All required properties are marked as required parameters to assist you on the command line. .DESCRIPTION The function supports all properties of an [Autotask.ContractRetainer] that can be updated through the Web Services API. The function uses PowerShell parameter validation and supports IntelliSense for selecting picklist values. Any required paramterer is marked as Mandatory in the PowerShell function to assist you on the command line. If you need very complicated queries you can write a filter directly and pass it using the -Filter parameter. To get the ContractRetainer with Id number 0 you could write 'New-AtwsContractRetainer -Id 0' or you could write 'New-AtwsContractRetainer -Filter {Id -eq 0}. 'New-AtwsContractRetainer -Id 0,4' could be written as 'New-AtwsContractRetainer -Filter {id -eq 0 -or id -eq 4}'. For simple queries you can see that using parameters is much easier than the -Filter option. But the -Filter option supports an arbitrary sequence of most operators (-eq, -ne, -gt, -ge, -lt, -le, -and, -or, -beginswith, -endswith, -contains, -like, -notlike, -soundslike, -isnotnull, -isnull, -isthisday). As you can group them using parenthesis '()' you can write arbitrarily complex queries with -Filter. To create a new ContractRetainer you need the following required fields: -ContractID -Status -DatePurchased -StartDate -EndDate -Amount Entities that have fields that refer to the base entity of this CmdLet: .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.ContractRetainer]. This function outputs the Autotask.ContractRetainer that was created by the API. .EXAMPLE $Result = New-AtwsContractRetainer -ContractID [Value] -Status [Value] -DatePurchased [Value] -StartDate [Value] -EndDate [Value] -Amount [Value] Creates a new [Autotask.ContractRetainer] through the Web Services API and returns the new object. .EXAMPLE $Result = Get-AtwsContractRetainer -Id 124 | New-AtwsContractRetainer Copies [Autotask.ContractRetainer] by Id 124 to a new object through the Web Services API and returns the new object. .EXAMPLE Get-AtwsContractRetainer -Id 124 | New-AtwsContractRetainer | Set-AtwsContractRetainer -ParameterName <Parameter Value> Copies [Autotask.ContractRetainer] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsContractRetainer to modify the object. .EXAMPLE $Result = Get-AtwsContractRetainer -Id 124 | New-AtwsContractRetainer | Set-AtwsContractRetainer -ParameterName <Parameter Value> -Passthru Copies [Autotask.ContractRetainer] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsContractRetainer to modify the object and returns the new object. .LINK Get-AtwsContractRetainer .LINK Set-AtwsContractRetainer #> [CmdLetBinding(DefaultParameterSetName='By_parameters', ConfirmImpact='Low')] Param ( # An array of objects to create [Parameter( ParameterSetName = 'Input_Object', ValueFromPipeline = $true )] [ValidateNotNullOrEmpty()] [Autotask.ContractRetainer[]] $InputObject, # Contract ID [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $ContractID, # Status [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $Status, # Paid [Parameter( ParameterSetName = 'By_parameters' )] [Int] $IsPaid, # Date Purchased [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $DatePurchased, # StartDate [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $StartDate, # EndDate [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $EndDate, # Amount [Parameter( Mandatory = $true, ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [double] $Amount, # InvoiceNumber [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string] $InvoiceNumber, # PaymentNumber [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string] $PaymentNumber, # Payment Type [Parameter( ParameterSetName = 'By_parameters' )] [Int] $paymentID, # Amount Approved [Parameter( ParameterSetName = 'By_parameters' )] [double] $AmountApproved, # Internal Currency Amount Approved [Parameter( ParameterSetName = 'By_parameters' )] [double] $InternalCurrencyAmountApproved, # Internal Currency Amount [Parameter( ParameterSetName = 'By_parameters' )] [double] $InternalCurrencyAmount ) Begin { $EntityName = 'ContractRetainer' # Enable modern -Debug behavior If ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) {$DebugPreference = 'Continue'} Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) $ProcessObject = @() # Set up TimeZone offset handling If (-not($script:ESToffset)) { $Now = Get-Date $ESTzone = [System.TimeZoneInfo]::FindSystemTimeZoneById("Eastern Standard Time") $ESTtime = [System.TimeZoneInfo]::ConvertTimeFromUtc($Now.ToUniversalTime(), $ESTzone) $script:ESToffset = (New-TimeSpan -Start $ESTtime -End $Now).TotalHours } } Process { $Fields = Get-AtwsFieldInfo -Entity $EntityName If ($InputObject) { Write-Verbose ('{0}: Copy Object mode: Setting ID property to zero' -F $MyInvocation.MyCommand.Name) $CopyNo = 1 Foreach ($Object in $InputObject) { # Create a new object and copy properties $NewObject = New-Object Autotask.$EntityName # Copy every non readonly property $FieldNames = $Fields.Where({$_.Name -ne 'id'}).Name If ($PSBoundParameters.ContainsKey('UserDefinedFields')) { $FieldNames += 'UserDefinedFields' } Foreach ($Field in $FieldNames) { $NewObject.$Field = $Object.$Field } If ($NewObject -is [Autotask.Ticket]) { Write-Verbose ('{0}: Copy Object mode: Object is a Ticket. Title must be modified to avoid duplicate detection.' -F $MyInvocation.MyCommand.Name) $Title = '{0} (Copy {1})' -F $NewObject.Title, $CopyNo $CopyNo++ $NewObject.Title = $Title } $ProcessObject += $NewObject } } Else { Write-Debug ('{0}: Creating empty [Autotask.{1}]' -F $MyInvocation.MyCommand.Name, $EntityName) $ProcessObject += New-Object Autotask.$EntityName } Foreach ($Parameter in $PSBoundParameters.GetEnumerator()) { $Field = $Fields | Where-Object {$_.Name -eq $Parameter.Key} If ($Field -or $Parameter.Key -eq 'UserDefinedFields') { If ($Field.IsPickList) { If($Field.PickListParentValueField) { $ParentField = $Fields.Where{$_.Name -eq $Field.PickListParentValueField} $ParentLabel = $PSBoundParameters.$($ParentField.Name) $ParentValue = $ParentField.PickListValues | Where-Object {$_.Label -eq $ParentLabel} $PickListValue = $Field.PickListValues | Where-Object {$_.Label -eq $Parameter.Value -and $_.ParentValue -eq $ParentValue.Value} } Else { $PickListValue = $Field.PickListValues | Where-Object {$_.Label -eq $Parameter.Value} } $Value = $PickListValue.Value } ElseIf ($Field.Type -eq 'datetime') { $TimePresent = $Parameter.Value.Hour -gt 0 -or $Parameter.Value.Minute -gt 0 -or $Parameter.Value.Second -gt 0 -or $Parameter.Value.Millisecond -gt 0 If ($Field.Name -like "*DateTime" -or $TimePresent) { # Yes, you really have to ADD the difference $Value = $Parameter.Value.AddHours($script:ESToffset) } Else { $Value = $Parameter.Value } } Else { $Value = $Parameter.Value } Foreach ($Object in $ProcessObject) { $Object.$($Parameter.Key) = $Value } } } $Result = New-AtwsData -Entity $ProcessObject # The API documentation explicitly states that you can only use the objects returned # by the .create() function to get the new objects ID. # so to return objects with accurately represents what has been created we have to # get them again by id # But not all objects support queries, for instance service adjustments $EntityInfo = Get-AtwsFieldInfo -Entity $EntityName -EntityInfo If ($EntityInfo.CanQuery) { $NewObjectFilter = 'id -eq {0}' -F ($Result.Id -join ' -or id -eq ') $Result = Get-AtwsData -Entity $EntityName -Filter $NewObjectFilter } } End { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) If ($PSCmdLet.ParameterSetName -eq 'Input_Object') { # Verify copy mode Foreach ($Object in $Result) { If ($InputObject.Id -contains $Object.Id) { Write-Warning ('{0}: Autotask detected new object as duplicate of {1} with Id {2} and tried to update object, not create a new copy. ' -F $MyInvocation.MyCommand.Name, $EntityName, $Object.Id) } } } Return $Result } } |