Add PolicyId output to Get-TeamViewerGroup function

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.5.2 (not released yet)
+
+### Updated
+
+- Updates `Get-TeamViewerGroup` to list the assigned PolicyID of a defined group
+
 
 ## 2.5.1 (not released yet)
 

Cmdlets/Private/ConvertTo-TeamViewerGroup.ps1

@@ -9,6 +9,7 @@ function ConvertTo-TeamViewerGroup {
             Id          = $InputObject.id
             Name        = $InputObject.name
             Permissions = $InputObject.permissions
+            PolicyId    = $InputObject.policy_id
             SharedWith  = @($InputObject.shared_with | ConvertTo-TeamViewerGroupShare)
         }
         if ($InputObject.owner) {

Cmdlets/Public/Get-TeamViewerGroup.ps1

@@ -52,6 +52,8 @@ function Get-TeamViewerGroup {
         Write-Output ($response | ConvertTo-TeamViewerGroup)
     }
     else {
-        Write-Output ($response.groups | ConvertTo-TeamViewerGroup)
+        $groups = @($response.groups | ConvertTo-TeamViewerGroup)
+        $groups | ForEach-Object { $_.PSObject.Properties.Remove('PolicyId') }
+        Write-Output $groups
     }
 }

Cmdlets/TeamViewerPS.psd1

@@ -3,7 +3,7 @@
     RootModule        = 'TeamViewerPS.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '2.5.1'
+    ModuleVersion     = '2.5.2'
 
     # Supported PSEditions.
     # CompatiblePSEditions = @()

Tests/Public/Get-TeamViewerGroup.Tests.ps1

@@ -10,11 +10,14 @@ BeforeAll {
     Mock Get-TeamViewerApiUri { '//unit.test' }
     Mock Invoke-TeamViewerRestMethod { @{
             groups = @(
-                @{ id = 'g1234'; name = 'test group 1' },
-                @{ id = 'g4567'; name = 'test group 2' },
-                @{ id = 'g8901'; name = 'test group 3' }
+                @{ id = 'g1234'; name = 'test group 1'; policy_id = 'p1234' },
+                @{ id = 'g4567'; name = 'test group 2'; policy_id = 'p4567' },
+                @{ id = 'g8901'; name = 'test group 3'; policy_id = 'p8901' }
             )
         } }
+    Mock Invoke-TeamViewerRestMethod { @{ id = 'g1234'; name = 'test group 1'; policy_id = 'p1234' } } -ParameterFilter {
+        $Uri -eq '//unit.test/groups/g1234'
+    }
 }
 
 Describe 'Get-TeamViewerGroup' {
@@ -29,7 +32,7 @@ Describe 'Get-TeamViewerGroup' {
     }
 
     It 'Should call the correct API endpoint for single group' {
-        Get-TeamViewerGroup -ApiToken $testApiToken -Group 'g1234'
+        Get-TeamViewerGroup -ApiToken $testApiToken -Id 'g1234'
 
         Assert-MockCalled Invoke-TeamViewerRestMethod -Times 1 -Scope It -ParameterFilter {
             $ApiToken -eq $testApiToken -And `
@@ -62,4 +65,14 @@ Describe 'Get-TeamViewerGroup' {
         Assert-MockCalled Invoke-TeamViewerRestMethod -Times 1 -Scope It -ParameterFilter {
             $Body -And $Body['name'] -eq 'TestName' }
     }
+
+    It 'Should include PolicyId when getting single group' {
+        $result = Get-TeamViewerGroup -ApiToken $testApiToken -Id 'g1234'
+        $result.PolicyId | Should -Be 'p1234'
+    }
+
+    It 'Should exclude PolicyId when filtering groups' {
+        $result = Get-TeamViewerGroup -ApiToken $testApiToken
+        $result[0].PSObject.Properties.Name | Should -Not -Contain 'PolicyId'
+    }
 }