Public/Conversations/Set-FreshServiceConversation.ps1
|
<#
.SYNOPSIS Updates a Freshservice Conversation. .DESCRIPTION Updates a Freshservice Conversation via REST API. https://api.freshservice.com/#update_a_conversations IMPORTANT - Only public & private notes can be edited (i.e. cannot edit a reply). .PARAMETER id Unique id of the conversation. .PARAMETER body Content of the note in HTML format. .PARAMETER attachments Conversation attachments. The total size of these attachments cannot exceed 15MB. .EXAMPLE Set-FreshServiceConversation -id 21009827673 -body '<div style="font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif; font-size: 18px; "><div>Test Note</div></div>' id : 21009827673 user_id : 21001931878 to_emails : {} body : <div style="font-family: -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,sans-serif; font-size: 18px; "><div>Test Note</div></div> body_text : Test Note ticket_id : 209 created_at : 3/30/2023 7:29:30 PM updated_at : 3/30/2023 7:32:03 PM incoming : False private : True support_email : attachments : {} Updates the body on a Freshservice Conversation. .NOTES This module was developed and tested with Freshservice REST API v2. #> function Set-FreshServiceConversation { [CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact='Medium')] param ( [Parameter( Mandatory = $true, HelpMessage = 'Unique ID of the conversation.', ValueFromPipelineByPropertyName = $true )] [Alias('note_id')] [long]$id, [Parameter( Mandatory = $false, HelpMessage = 'Content of the note in HTML format.', ValueFromPipelineByPropertyName = $true )] [string]$body, [Parameter( Mandatory = $false, HelpMessage = 'Conversation attachments. The total size of these attachments cannot exceed 15MB.', ValueFromPipelineByPropertyName = $true, ParameterSetName = 'default', Position = 11 )] [ValidateScript({ if(-Not ($_ | Test-Path) ){ throw ("Cannot find path {0} because it does not exist." -f $_.FullName) } if(-Not ($_ | Test-Path -PathType Leaf) ){ throw ("{0} is not a valid file. Folder paths are not allowed." -f $_.FullName) } if($_.Length/1MB -gt 15 ) { throw ("{0} exceeds the file size limit. Files must be under 15MB." -f $_.FullName) } return $true })] [System.IO.FileInfo[]]$attachments ) begin { $PrivateData = $MyInvocation.MyCommand.Module.PrivateData if (!$PrivateData.FreshserviceBaseUri) { throw "No connection found! Setup a new Freshservice connection with New-FreshServiceConnection and then Connect-FreshService. Set a default connection with New-FreshServiceConnection or Set-FreshConnection to automatically connect when importing the module." } } process { $uri = [System.UriBuilder]('{0}/conversations' -f $PrivateData['FreshserviceBaseUri']) if ($PSBoundParameters.ContainsKey('id')) { $uri.Path = "{0}/{1}" -f $uri.Path, $id [void]$PSBoundParameters.Remove('Id') } $jsonBody = @{} $PSBoundParameters.keys.where{ $PSItem -notin $PrivateData.FreshserviceBodyExclusions }.foreach{ $jsonBody[$PSItem.ToLower()] = $PSBoundParameters[$PSItem] } try { if ($PSCmdlet.ShouldProcess($uri.Uri.AbsoluteUri)) { $params = @{ Uri = $uri.Uri.AbsoluteUri Method = 'PUT' ErrorAction = 'Stop' } if ( $attachments ) { if ( $PSVersionTable.PSVersion.Major -lt 7 ) { Write-Warning "Sorry! Attachments are not currently supported in versions earlier than Powershell 7.x due to multipart/form-data requirements. Attachment parameter will be ignored." $jsonBody.Remove('attachments') $params.Body = $jsonBody | ConvertTo-Json } else { #Invoke-WebRequest -Form is supported in 7+ $jsonBody.Add('attachments[]',$attachments) $jsonBody.Remove('attachments') $params.Form = $jsonBody } } else { $params.Body = $jsonBody | ConvertTo-Json } $result = Invoke-FreshworksRestMethod @params if ($result.Content) { $content = $result.Content | ConvertFrom-Json #API returns singluar or plural property based on the number of records, parse to get property returned. $objProperty = $content[0].PSObject.Properties.Name Write-Verbose -Message ("Returning {0} property with count {1}" -f $objProperty, $content."$($objProperty)".Count) $content."$($objProperty)" } } } catch { Throw $_ } } end {} } |