Add support for creating, updating, and removing related items (#88)

* Add support for creating, updating, and removing related items

* faster processing and cleaner method for nulling the output

* Little cleanup of [CmdletBinding()]

* Update params to be idiomatic

The other functions all use $id, so updated $related_items_id to match

Co-authored-by: Caleb Albers <[email protected]>

Author: DrDrrae

ITGlueAPI/ITGlueAPI.psd1

@@ -97,6 +97,7 @@ NestedModules = 'Internal/BaseURI.ps1',
                 'Resources/Passwords.ps1',
                 'Resources/Platforms.ps1',
                 'Resources/Regions.ps1',
+                'Resources/RelatedItems.ps1',
                 'Resources/UserMetrics.ps1',
                 'Resources/Users.ps1'
 
@@ -205,6 +206,10 @@ FunctionsToExport = 'Add-ITGlueAPIKey',
 
                     'Get-ITGlueRegions',
 
+                    'New-ITGlueRelatedItems',
+                    'Set-ITGlueRelatedItems',
+                    'Remove-ITGlueRelatedItems',
+
                     'Get-ITGlueUserMetrics',
 
                     'Get-ITGlueUsers',

ITGlueAPI/Resources/RelatedItems.ps1

@@ -0,0 +1,117 @@
+function New-ITGlueRelatedItems {
+    [CmdletBinding()]
+    Param (
+        [Parameter(Mandatory = $true)]    
+        [ValidateSet( 'checklists', 'checklist_templates', 'configurations', 'contacts', 'documents', `
+                'domains', 'locations', 'passwords', 'ssl_certificates', 'flexible_assets', 'tickets')]
+        [string]$resource_type,
+
+        [Parameter(Mandatory = $true)]
+        [int64]$resource_id,
+
+        [Parameter(Mandatory = $true)]
+        $data
+    )
+
+    $resource_uri = ('/{0}/{1}/relationships/related_items' -f $resource_type, $resource_id)
+
+    $body = @{}
+
+    $body += @{'data'= $data}
+
+    $body = ConvertTo-Json -InputObject $body -Depth $ITGlue_JSON_Conversion_Depth
+
+    try {
+        $ITGlue_Headers.Add('x-api-key', (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList 'N/A', $ITGlue_API_Key).GetNetworkCredential().Password)
+        $rest_output = Invoke-RestMethod -method 'POST' -uri ($ITGlue_Base_URI + $resource_uri) -headers $ITGlue_Headers `
+            -body $body -ErrorAction Stop -ErrorVariable $web_error
+    } catch {
+        Write-Error $_
+    } finally {
+        [void] $ITGlue_Headers.Remove('x-api-key') # Quietly clean up scope so the API key doesn't persist
+    }
+
+    $data = @{}
+    $data = $rest_output 
+    return $data
+}
+
+function Set-ITGlueRelatedItems {
+    [CmdletBinding()]
+    Param (
+        [Parameter(Mandatory = $true)]    
+        [ValidateSet( 'checklists', 'checklist_templates', 'configurations', 'contacts', 'documents', `
+                'domains', 'locations', 'passwords', 'ssl_certificates', 'flexible_assets', 'tickets')]
+        [string]$resource_type,
+
+        [Parameter(Mandatory = $true)]
+        [int64]$resource_id,
+
+        [Parameter(Mandatory = $true)]
+        [int64]$id,
+
+        [Parameter(Mandatory = $true)]
+        $data
+
+    )
+
+    $resource_uri = ('/{0}/{1}/relationships/related_items/{2}' -f $resource_type, $resource_id, $id)
+
+    $body = @{}
+
+    $body += @{'data' = $data}
+
+    $body = ConvertTo-Json -InputObject $body -Depth $ITGlue_JSON_Conversion_Depth
+
+    try {
+        $ITGlue_Headers.Add('x-api-key', (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList 'N/A', $ITGlue_API_Key).GetNetworkCredential().Password)
+        $rest_output = Invoke-RestMethod -method 'PATCH' -uri ($ITGlue_Base_URI + $resource_uri) -headers $ITGlue_Headers `
+            -body $body -ErrorAction Stop -ErrorVariable $web_error
+    } catch {
+        Write-Error $_
+    } finally {
+        [void] $ITGlue_Headers.Remove('x-api-key') # Quietly clean up scope so the API key doesn't persist
+    }
+
+    $data = @{}
+    $data = $rest_output 
+    return $data
+}
+
+function Remove-ITGlueRelatedItems {
+    [CmdletBinding()]
+    Param (
+        [Parameter(Mandatory = $true)]    
+        [ValidateSet( 'checklists', 'checklist_templates', 'configurations', 'contacts', 'documents', `
+                'domains', 'locations', 'passwords', 'ssl_certificates', 'flexible_assets', 'tickets')]
+        [string]$resource_type,
+
+        [Parameter(Mandatory = $true)]
+        [int64]$resource_id,
+
+        [Parameter(Mandatory = $true)]
+        $data
+    )
+
+    $resource_uri = ('/{0}/{1}/relationships/related_items' -f $resource_type, $resource_id)
+
+    $body = @{}
+
+    $body += @{'data' = $data}
+
+    $body = ConvertTo-Json -InputObject $body -Depth $ITGlue_JSON_Conversion_Depth
+
+    try {
+        $ITGlue_Headers.Add('x-api-key', (New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList 'N/A', $ITGlue_API_Key).GetNetworkCredential().Password)
+        $rest_output = Invoke-RestMethod -method 'DELETE' -uri ($ITGlue_Base_URI + $resource_uri) -headers $ITGlue_Headers `
+            -body $body -ErrorAction Stop -ErrorVariable $web_error
+    } catch {
+        Write-Error $_
+    } finally {
+        [void] $ITGlue_Headers.Remove('x-api-key') # Quietly clean up scope so the API key doesn't persist
+    }
+
+    $data = @{}
+    $data = $rest_output 
+    return $data
+}