Dynamic/New-AtwsQuote.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
#Requires -Version 4.0 #Version 1.6.5 <# .COPYRIGHT Copyright (c) ECIT Solutions AS. All rights reserved. Licensed under the MIT license. See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. #> Function New-AtwsQuote { <# .SYNOPSIS This function creates a new Quote 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.Quote] 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 Quote with Id number 0 you could write 'New-AtwsQuote -Id 0' or you could write 'New-AtwsQuote -Filter {Id -eq 0}. 'New-AtwsQuote -Id 0,4' could be written as 'New-AtwsQuote -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 Quote you need the following required fields: -OpportunityID -Name -EffectiveDate -ExpirationDate -BillToLocationID -ShipToLocationID -SoldToLocationID Entities that have fields that refer to the base entity of this CmdLet: NotificationHistory QuoteItem .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.Quote]. This function outputs the Autotask.Quote that was created by the API. .EXAMPLE $result = New-AtwsQuote -OpportunityID [Value] -Name [Value] -EffectiveDate [Value] -ExpirationDate [Value] -BillToLocationID [Value] -ShipToLocationID [Value] -SoldToLocationID [Value] Creates a new [Autotask.Quote] through the Web Services API and returns the new object. .EXAMPLE $result = Get-AtwsQuote -Id 124 | New-AtwsQuote Copies [Autotask.Quote] by Id 124 to a new object through the Web Services API and returns the new object. .EXAMPLE Get-AtwsQuote -Id 124 | New-AtwsQuote | Set-AtwsQuote -ParameterName <Parameter Value> Copies [Autotask.Quote] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsQuote to modify the object. .EXAMPLE $result = Get-AtwsQuote -Id 124 | New-AtwsQuote | Set-AtwsQuote -ParameterName <Parameter Value> -Passthru Copies [Autotask.Quote] by Id 124 to a new object through the Web Services API, passes the new object to the Set-AtwsQuote to modify the object and returns the new object. .LINK Get-AtwsQuote .LINK Set-AtwsQuote #> [CmdLetBinding(SupportsShouldProcess = $true, DefaultParameterSetName='By_parameters', ConfirmImpact='Low')] Param ( # An array of objects to create [Parameter( ParametersetName = 'Input_Object', ValueFromPipeline = $true )] [ValidateNotNullOrEmpty()] [Autotask.Quote[]] $InputObject, # opportunity_id [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $OpportunityID, # quote_name [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(0,100)] [string] $Name, # equote_active [Parameter( ParametersetName = 'By_parameters' )] [boolean] $eQuoteActive, # effective_date [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $EffectiveDate, # expiration_date [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [datetime] $ExpirationDate, # create_date [Parameter( ParametersetName = 'By_parameters' )] [datetime] $CreateDate, # create_by_id [Parameter( ParametersetName = 'By_parameters' )] [Int] $CreatorResourceID, # contact_id [Parameter( ParametersetName = 'By_parameters' )] [Int] $ContactID, # tax_region_id [Parameter( ParametersetName = 'By_parameters' )] [string] $TaxGroup, # project_id [Parameter( ParametersetName = 'By_parameters' )] [Int] $ProposalProjectID, # bill_to_location_id [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $BillToLocationID, # ship_to_location_id [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $ShipToLocationID, # sold_to_location_id [Parameter( Mandatory = $true, ParametersetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int] $SoldToLocationID, # shipping_type_id [Parameter( ParametersetName = 'By_parameters' )] [string] $ShippingType, # payment_type_id [Parameter( ParametersetName = 'By_parameters' )] [string] $PaymentType, # payment_term_id [Parameter( ParametersetName = 'By_parameters' )] [string] $PaymentTerm, # external_quote_number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string] $ExternalQuoteNumber, # purchase_order_number [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,50)] [string] $PurchaseOrderNumber, # quote_comment [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,1000)] [string] $Comment, # quote_description [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,2000)] [string] $Description, # AccountID [Parameter( ParametersetName = 'By_parameters' )] [Int] $AccountID, # calculate_tax_separately [Parameter( ParametersetName = 'By_parameters' )] [boolean] $CalculateTaxSeparately, # group_by_product_category [Parameter( ParametersetName = 'By_parameters' )] [boolean] $GroupByProductCategory, # show_each_tax_in_tax_group [Parameter( ParametersetName = 'By_parameters' )] [boolean] $ShowEachTaxInGroup, # Show Tax Category [Parameter( ParametersetName = 'By_parameters' )] [boolean] $ShowTaxCategory, # is_primary_quote [Parameter( ParametersetName = 'By_parameters' )] [boolean] $PrimaryQuote, # Last Activity Date [Parameter( ParametersetName = 'By_parameters' )] [datetime] $LastActivityDate, # Last Modified By [Parameter( ParametersetName = 'By_parameters' )] [Int] $LastModifiedBy, # Quote Template ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $QuoteTemplateID, # Group By ID [Parameter( ParametersetName = 'By_parameters' )] [string] $GroupByID, # Quote Number [Parameter( ParametersetName = 'By_parameters' )] [Int] $QuoteNumber, # Ext Approval Contact Response [Parameter( ParametersetName = 'By_parameters' )] [string] $ExtApprovalContactResponse, # Ext Approval Response Signature [Parameter( ParametersetName = 'By_parameters' )] [ValidateLength(0,250)] [string] $ExtApprovalResponseSignature, # Ext Approval Response Date [Parameter( ParametersetName = 'By_parameters' )] [datetime] $ExtApprovalResponseDate, # Approval Status [Parameter( ParametersetName = 'By_parameters' )] [string] $ApprovalStatus, # Approval Status Changed Date [Parameter( ParametersetName = 'By_parameters' )] [datetime] $ApprovalStatusChangedDate, # Approval Status Changed By Resource ID [Parameter( ParametersetName = 'By_parameters' )] [Int] $ApprovalStatusChangedByResourceID ) begin { $entityName = 'Quote' # Enable modern -Debug behavior if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } else { # Respect configured preference $DebugPreference = $Script:Atws.Configuration.DebugPref } Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) if (!($PSCmdlet.MyInvocation.BoundParameters['Verbose'].IsPresent)) { # No local override of central preference. Load central preference $VerbosePreference = $Script:Atws.Configuration.VerbosePref } $processObject = @() } process { if ($InputObject) { Write-Verbose -Message ('{0}: Copy Object mode: Setting ID property to zero' -F $MyInvocation.MyCommand.Name) $fields = Get-AtwsFieldInfo -Entity $entityName $CopyNo = 1 foreach ($object in $InputObject) { # Create a new object and copy properties $newObject = New-Object -TypeName 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 -Message ('{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 -Message ('{0}: Creating empty [Autotask.{1}]' -F $MyInvocation.MyCommand.Name, $entityName) $processObject += New-Object -TypeName Autotask.$entityName } # Prepare shouldProcess comments $caption = $MyInvocation.MyCommand.Name $verboseDescription = '{0}: About to create {1} {2}(s). This action cannot be undone.' -F $caption, $processObject.Count, $entityName $verboseWarning = '{0}: About to create {1} {2}(s). This action may not be undoable. Do you want to continue?' -F $caption, $processObject.Count, $entityName # Lets don't and say we did! if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { # Process parameters and update objects with their values $processObject = $processObject | Update-AtwsObjectsWithParameters -BoundParameters $PSBoundParameters -EntityName $EntityName $result = Set-AtwsData -Entity $processObject -Create } } end { Write-Debug -Message ('{0}: End of function, returning {1} {2}(s)' -F $MyInvocation.MyCommand.Name, $result.count, $entityName) Return $result } } |