Dynamic/Get-AtwsContact.ps1
|
#Requires -Version 4.0 #Version 1.6.2.8 <# .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 Get-AtwsContact { <# .SYNOPSIS This function get one or more Contact through the Autotask Web Services API. .DESCRIPTION This function creates a query based on any parameters you give and returns any resulting objects from the Autotask Web Services Api. By default the function returns any objects with properties that are Equal (-eq) to the value of the parameter. To give you more flexibility you can modify the operator by using -NotEquals [ParameterName[]], -LessThan [ParameterName[]] and so on. Possible operators for all parameters are: -NotEquals -GreaterThan -GreaterThanOrEqual -LessThan -LessThanOrEquals Additional operators for [String] parameters are: -Like (supports * or % as wildcards) -NotLike -BeginsWith -EndsWith -Contains Properties with picklists are: NamePrefix NameSuffix Entities that have fields that refer to the base entity of this CmdLet: AccountNote AccountToDo AttachmentInfo ClientPortalUser ContactGroupContact Contract InstalledProduct NotificationHistory Opportunity Quote SalesOrder SurveyResults Ticket TicketAdditionalContact TicketChangeRequestApproval .INPUTS Nothing. This function only takes parameters. .OUTPUTS [Autotask.Contact[]]. This function outputs the Autotask.Contact that was returned by the API. .EXAMPLE Get-AtwsContact -Id 0 Returns the object with Id 0, if any. .EXAMPLE Get-AtwsContact -ContactName SomeName Returns the object with ContactName 'SomeName', if any. .EXAMPLE Get-AtwsContact -ContactName 'Some Name' Returns the object with ContactName 'Some Name', if any. .EXAMPLE Get-AtwsContact -ContactName 'Some Name' -NotEquals ContactName Returns any objects with a ContactName that is NOT equal to 'Some Name', if any. .EXAMPLE Get-AtwsContact -ContactName SomeName* -Like ContactName Returns any object with a ContactName that matches the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsContact -ContactName SomeName* -NotLike ContactName Returns any object with a ContactName that DOES NOT match the simple pattern 'SomeName*'. Supported wildcards are * and %. .EXAMPLE Get-AtwsContact -NamePrefix <PickList Label> Returns any Contacts with property NamePrefix equal to the <PickList Label>. '-PickList' is any parameter on . .EXAMPLE Get-AtwsContact -NamePrefix <PickList Label> -NotEquals NamePrefix Returns any Contacts with property NamePrefix NOT equal to the <PickList Label>. .EXAMPLE Get-AtwsContact -NamePrefix <PickList Label1>, <PickList Label2> Returns any Contacts with property NamePrefix equal to EITHER <PickList Label1> OR <PickList Label2>. .EXAMPLE Get-AtwsContact -NamePrefix <PickList Label1>, <PickList Label2> -NotEquals NamePrefix Returns any Contacts with property NamePrefix NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .EXAMPLE Get-AtwsContact -Id 1234 -ContactName SomeName* -NamePrefix <PickList Label1>, <PickList Label2> -Like ContactName -NotEquals NamePrefix -GreaterThan Id An example of a more complex query. This command returns any Contacts with Id GREATER THAN 1234, a ContactName that matches the simple pattern SomeName* AND that has a NamePrefix that is NOT equal to NEITHER <PickList Label1> NOR <PickList Label2>. .LINK New-AtwsContact .LINK Remove-AtwsContact .LINK Set-AtwsContact #> [CmdLetBinding(DefaultParameterSetName='Filter', ConfirmImpact='None')] Param ( # A filter that limits the number of objects that is returned from the API [Parameter( Mandatory = $true, ValueFromRemainingArguments = $true, ParameterSetName = 'Filter' )] [ValidateNotNullOrEmpty()] [String[]] $Filter, # Follow this external ID and return any external objects [Parameter( ParameterSetName = 'Filter' )] [Parameter( ParameterSetName = 'By_parameters' )] [Alias('GetRef')] [ValidateNotNullOrEmpty()] [ValidateSet('AccountID', 'CountryID', 'AccountPhysicalLocationID')] [String] $GetReferenceEntityById, # Return entities of selected type that are referencing to this entity. [Parameter( ParameterSetName = 'Filter' )] [Parameter( ParameterSetName = 'By_parameters' )] [Alias('External')] [ValidateNotNullOrEmpty()] [ValidateSet('Contract:ContactID', 'Contract:BillToAccountContactID', 'AttachmentInfo:AttachedByContactID', 'SurveyResults:ContactID', 'InstalledProduct:ContactID', 'InstalledProduct:InstalledByContactID', 'ContactGroupContact:ContactID', 'Opportunity:ContactID', 'TicketAdditionalContact:ContactID', 'TicketChangeRequestApproval:ContactID', 'ClientPortalUser:ContactID', 'AccountNote:ContactID', 'Quote:ContactID', 'AccountToDo:ContactID', 'Ticket:ContactID', 'SalesOrder:Contact', 'NotificationHistory:InitiatingContactID')] [String] $GetExternalEntityByThisEntityId, # Return all objects in one query [Parameter( ParameterSetName = 'Get_all' )] [Switch] $All, # Do not add descriptions for all picklist attributes with values [Parameter( ParameterSetName = 'Filter' )] [Parameter( ParameterSetName = 'Get_all' )] [Parameter( ParameterSetName = 'By_parameters' )] [Switch] $NoPickListLabel, # A single user defined field can be used pr query [Parameter( ParameterSetName = 'By_parameters' )] [Alias('UDF')] [ValidateNotNullOrEmpty()] [Autotask.UserDefinedField] $UserDefinedField, # Contact ID [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [long[]] $id, # Client [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int[]] $AccountID, # First Name [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(1,50)] [string[]] $FirstName, # Last Name [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [ValidateLength(1,50)] [string[]] $LastName, # Middle Initial [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,2)] [string[]] $MiddleInitial, # Title [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string[]] $Title, # Contact Address 1 [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,128)] [string[]] $AddressLine, # Contact Address 2 [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,128)] [string[]] $AddressLine1, # Contact City [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,32)] [string[]] $City, # Contact County [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,40)] [string[]] $State, # Contact Postal Code [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,16)] [string[]] $ZipCode, # Contact Country [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,100)] [string[]] $Country, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,254)] [string[]] $EMailAddress, # Email2 [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,254)] [string[]] $EMailAddress2, # Email3 [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,254)] [string[]] $EMailAddress3, # Notification [Parameter( ParameterSetName = 'By_parameters' )] [boolean[]] $Notification, # Contact Phone [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,25)] [string[]] $Phone, # Contact Phone Ext. [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,10)] [string[]] $Extension, # Contact Alternate Phone [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,32)] [string[]] $AlternatePhone, # Contact Mobile Phone [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,25)] [string[]] $MobilePhone, # Contact Fax [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,25)] [string[]] $FaxNumber, # Note [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string[]] $Note, # Last Activity Date [Parameter( ParameterSetName = 'By_parameters' )] [datetime[]] $LastActivityDate, # Room Number [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string[]] $RoomNumber, # Active [Parameter( ParameterSetName = 'By_parameters' )] [ValidateNotNullOrEmpty()] [Int[]] $Active, # Create Date [Parameter( ParameterSetName = 'By_parameters' )] [datetime[]] $CreateDate, # Last Modified Date [Parameter( ParameterSetName = 'By_parameters' )] [datetime[]] $LastModifiedDate, # Additional Address Information [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,100)] [string[]] $AdditionalAddressInformation, # External ID [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,50)] [string[]] $ExternalID, # Contact Country ID [Parameter( ParameterSetName = 'By_parameters' )] [Int[]] $CountryID, # Bulk Email Opt Out Time [Parameter( ParameterSetName = 'By_parameters' )] [datetime[]] $BulkEmailOptOutTime, # Name Prefix [Parameter( ParameterSetName = 'By_parameters' )] [String[]] $NamePrefix, # Name Suffix [Parameter( ParameterSetName = 'By_parameters' )] [String[]] $NameSuffix, # Facebook URL [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,200)] [string[]] $FacebookUrl, # Twitter URL [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,200)] [string[]] $TwitterUrl, # LinkedIn URL [Parameter( ParameterSetName = 'By_parameters' )] [ValidateLength(1,200)] [string[]] $LinkedInUrl, # Primary Contact [Parameter( ParameterSetName = 'By_parameters' )] [boolean[]] $PrimaryContact, # Account Physical Location [Parameter( ParameterSetName = 'By_parameters' )] [Int[]] $AccountPhysicalLocationID, # Solicitation Opt Out Time [Parameter( ParameterSetName = 'By_parameters' )] [datetime[]] $SolicitationOptOutTime, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Notification', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'PrimaryContact', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $NotEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Notification', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'PrimaryContact', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $IsNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Notification', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'PrimaryContact', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $IsNotNull, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $GreaterThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $GreaterThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $LessThan, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('id', 'AccountID', 'FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'LastActivityDate', 'RoomNumber', 'Active', 'CreateDate', 'LastModifiedDate', 'AdditionalAddressInformation', 'ExternalID', 'CountryID', 'BulkEmailOptOutTime', 'NamePrefix', 'NameSuffix', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'AccountPhysicalLocationID', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $LessThanOrEquals, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'RoomNumber', 'AdditionalAddressInformation', 'ExternalID', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'UserDefinedField')] [String[]] $Like, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'RoomNumber', 'AdditionalAddressInformation', 'ExternalID', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'UserDefinedField')] [String[]] $NotLike, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'RoomNumber', 'AdditionalAddressInformation', 'ExternalID', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'UserDefinedField')] [String[]] $BeginsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'RoomNumber', 'AdditionalAddressInformation', 'ExternalID', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'UserDefinedField')] [String[]] $EndsWith, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('FirstName', 'LastName', 'MiddleInitial', 'Title', 'AddressLine', 'AddressLine1', 'City', 'State', 'ZipCode', 'Country', 'EMailAddress', 'EMailAddress2', 'EMailAddress3', 'Phone', 'Extension', 'AlternatePhone', 'MobilePhone', 'FaxNumber', 'Note', 'RoomNumber', 'AdditionalAddressInformation', 'ExternalID', 'FacebookUrl', 'TwitterUrl', 'LinkedInUrl', 'UserDefinedField')] [String[]] $Contains, [Parameter( ParameterSetName = 'By_parameters' )] [ValidateSet('LastActivityDate', 'CreateDate', 'LastModifiedDate', 'BulkEmailOptOutTime', 'SolicitationOptOutTime', 'UserDefinedField')] [String[]] $IsThisDay ) Begin { $EntityName = 'Contact' # Enable modern -Debug behavior If ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) {$DebugPreference = 'Continue'} Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) } Process { If ($PSCmdlet.ParameterSetName -eq 'Get_all') { $Filter = @('id', '-ge', 0) } ElseIf (-not ($Filter)) { Write-Debug ('{0}: Query based on parameters, parsing' -F $MyInvocation.MyCommand.Name) # Convert named parameters to a filter definition that can be parsed to QueryXML $Filter = ConvertTo-AtwsFilter -BoundParameters $PSBoundParameters -EntityName $EntityName } Else { Write-Debug ('{0}: Query based on manual filter, parsing' -F $MyInvocation.MyCommand.Name) $Filter = . Update-AtwsFilter -FilterString $Filter } $Result = Get-AtwsData -Entity $EntityName -Filter $Filter Write-Verbose ('{0}: Number of entities returned by base query: {1}' -F $MyInvocation.MyCommand.Name, $Result.Count) # Datetimeparameters $Fields = Get-AtwsFieldInfo -Entity $EntityName # Should we return an indirect object? if ( ($Result) -and ($GetReferenceEntityById)) { Write-Debug ('{0}: User has asked for external reference objects by {1}' -F $MyInvocation.MyCommand.Name, $GetReferenceEntityById) $Field = $Fields.Where({$_.Name -eq $GetReferenceEntityById}) $ResultValues = $Result | Where-Object {$null -ne $_.$GetReferenceEntityById} If ($ResultValues.Count -lt $Result.Count) { Write-Warning ('{0}: Only {1} of the {2}s in the primary query had a value in the property {3}.' -F $MyInvocation.MyCommand.Name, $ResultValues.Count, $EntityName, $GetReferenceEntityById) -WarningAction Continue } $Filter = 'id -eq {0}' -F $($ResultValues.$GetReferenceEntityById -join ' -or id -eq ') $Result = Get-Atwsdata -Entity $Field.ReferenceEntityType -Filter $Filter } ElseIf ( ($Result) -and ($GetExternalEntityByThisEntityId)) { Write-Debug ('{0}: User has asked for {1} that are referencing this result' -F $MyInvocation.MyCommand.Name, $GetExternalEntityByThisEntityId) $ReferenceInfo = $GetExternalEntityByThisEntityId -Split ':' $Filter = '{0} -eq {1}' -F $ReferenceInfo[1], $($Result.id -join (' -or {0}id -eq ' -F $ReferenceInfo[1])) $Result = Get-Atwsdata -Entity $ReferenceInfo[0] -Filter $Filter } # Do the user want labels along with index values for Picklists? ElseIf ( ($Result) -and -not ($NoPickListLabel)) { Foreach ($Field in $Fields.Where{$_.IsPickList}) { $FieldName = '{0}Label' -F $Field.Name Foreach ($Item in $Result) { $Value = ($Field.PickListValues.Where{$_.Value -eq $Item.$($Field.Name)}).Label Add-Member -InputObject $Item -MemberType NoteProperty -Name $FieldName -Value $Value -Force } } } } End { Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) If ($Result) { Return $Result } } } |