Harmonize cmdlet names

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Added
 
-- Adds commands to manage the user roles of a TeamViewer company.
+- Adds commands to manage the roles of a TeamViewer company.
 - Adds `Set-TeamViewerApiURi` to use TeamViewer test API.
 - Adds `Add-TeamViewerAssignment` and `Remove-TeamViewerAssignment` commands to assign and unassign a device from a TeamViewer company.
 - Adds `Add-TeamViewerCustomization` and `Remove-TeamViewerCustomization` commands to apply and remove customization.

Cmdlets/Private/ConvertTo-TeamViewerPredefinedRole.ps1

@@ -7,7 +7,7 @@ function ConvertTo-TeamViewerPredefinedRole {
     process {
         if($InputObject){
         $properties = @{
-            PredefinedRoleId = $InputObject.PredefineduserRoleId
+            PredefinedRoleId = $InputObject.PredefinedRoleId
         }
     }
 

Cmdlets/Private/ConvertTo-TeamViewerUserRole.ps1 → Cmdlets/Private/ConvertTo-TeamViewerRole.ps1

@@ -1,4 +1,4 @@
-function ConvertTo-TeamViewerUserRole {
+function ConvertTo-TeamViewerRole {
     param(
         [Parameter(ValueFromPipeline)]
         [PSObject]
@@ -15,7 +15,7 @@ function ConvertTo-TeamViewerUserRole {
             }
         }
         $result = New-Object -TypeName PSObject -Property $properties
-        $result.PSObject.TypeNames.Insert(0, 'TeamViewerPS.UserRole')
+        $result.PSObject.TypeNames.Insert(0, 'TeamViewerPS.Role')
         $result | Add-Member -MemberType ScriptMethod -Name 'ToString' -Force -Value {
             Write-Output "[$($this.RoleName)] [$($this.RoleID)] $($this.Permissions))"
         }

Cmdlets/Private/Resolve-TeamViewerRoleId.ps1

@@ -0,0 +1,19 @@
+
+function Resolve-TeamViewerRoleId {
+    param(
+        [Parameter(ValueFromPipeline = $true, Mandatory = $true)]
+        [Object]
+        $Role
+    )
+    Process {
+        if ($Role.PSObject.TypeNames -contains 'TeamViewerPS.Role') {
+            return [string]$Role.RoleID
+        }
+        elseif ($Role -match '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$') {
+            return [string]$Role
+        }
+        else {
+            throw "Invalid role identifier '$Role'. Must be either a [TeamViewerPS.Role] or [UUID] "
+        }
+    }
+}

Cmdlets/Public/Add-TeamViewerUserGroupToUserRole.ps1 → Cmdlets/Public/Add-TeamViewerUserGroupToRole.ps1

@@ -1,15 +1,15 @@
-function Add-TeamViewerUserGroupToUserRole {
+function Add-TeamViewerUserGroupToRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRoleId')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('RoleId')]
         [object]
-        $UserRole,
+        $Role,
 
         [Parameter(Mandatory = $true)]
         [ValidateScript( { $_ | Resolve-TeamViewerUserGroupId } )]
@@ -20,11 +20,11 @@ function Add-TeamViewerUserGroupToUserRole {
     )
 
     Begin {
-        $RoleId = $UserRole | Resolve-TeamViewerUserRoleId
+        $RoleId = $Role | Resolve-TeamViewerRoleId
         $null = $ApiToken
         $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assign/usergroup"
         $body = @{
-            UserRoleId  = $RoleId
+            RoleId      = $RoleId
             UserGroupId = $UserGroup
 
         }

Cmdlets/Public/Add-TeamViewerAccountToUserRole.ps1 → Cmdlets/Public/Add-TeamViewerUserToRole.ps1

@@ -1,15 +1,15 @@
-function Add-TeamViewerAccountToUserRole {
+function Add-TeamViewerUserToRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRole')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('Role')]
         [object]
-        $UserRoleId,
+        $RoleId,
 
         [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [Alias('Id', 'UserIds')]
@@ -18,13 +18,13 @@ function Add-TeamViewerAccountToUserRole {
     )
 
     Begin {
-        $id = $UserRoleId | Resolve-TeamViewerUserRoleId
+        $id = $RoleId | Resolve-TeamViewerRoleId
         $null = $ApiToken
         $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assign/account"
         $AccountsToAdd = @()
         $body = @{
-            UserIds    = @()
-            UserRoleId = $id
+            UserIds = @()
+            RoleId  = $id
         }
         function Invoke-TeamViewerRestMethodInternal {
             $result = Invoke-TeamViewerRestMethod `

Cmdlets/Public/Get-TeamViewerUserRole.ps1 → Cmdlets/Public/Get-TeamViewerRole.ps1

@@ -1,4 +1,4 @@
-function Get-TeamViewerUserRole {
+function Get-TeamViewerRole {
     [CmdletBinding(DefaultParameterSetName = '')]
     param(
         [Parameter(Mandatory = $true)]
@@ -19,6 +19,6 @@ Process{
         -Body $parameters `
         -WriteErrorTo $PSCmdlet `
         -ErrorAction Stop
-    Write-Output ($response.Roles | ConvertTo-TeamViewerUserRole )
+    Write-Output ($response.Roles | ConvertTo-TeamViewerRole )
 }
 }

Cmdlets/Public/Get-TeamViewerRoleAssignmentToAccount.ps1 → Cmdlets/Public/Get-TeamViewerUserByRole.ps1

@@ -1,18 +1,18 @@
-function Get-TeamViewerRoleAssignmentToAccount {
+function Get-TeamViewerUserByRole {
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRole')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('Role')]
         [string]
-        $UserRoleId
+        $RoleId
     )
 
 
-    $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assignments/account?userRoleId=$UserRoleId"
+    $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assignments/account?userRoleId=$RoleId"
     $parameters = $null
     do {
         $response = Invoke-TeamViewerRestMethod `

Cmdlets/Public/Get-TeamViewerRoleAssignmentToUserGroup.ps1 → Cmdlets/Public/Get-TeamViewerUserGroupByRole.ps1

@@ -1,18 +1,18 @@
-function Get-TeamViewerRoleAssignmentToUserGroup {
+function Get-TeamViewerUserGroupByRole {
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript({ $_ | Resolve-TeamviewerUserRoleId })]
-        [Alias('UserRole')]
+        [ValidateScript({ $_ | Resolve-TeamViewerRoleId })]
+        [Alias('Role')]
         [string]
-        $UserRoleId
+        $RoleId
     )
 
     Begin {
-        $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assignments/usergroups?userRoleId=$UserRoleId"
+        $resourceUri = "$(Get-TeamViewerApiUri)/userroles/assignments/usergroups?userRoleId=$RoleId"
         $parameters = $null
     }
     Process {
@@ -25,7 +25,7 @@ function Get-TeamViewerRoleAssignmentToUserGroup {
                 -WriteErrorTo $PSCmdlet `
                 -ErrorAction Stop
             if ($response.ContinuationToken) {
-                $resourceUri += "&continuationToken=" + $response.ContinuationToken
+                $resourceUri += '&continuationToken=' + $response.ContinuationToken
             }
             Write-Output ($response.AssignedToGroups | ConvertTo-TeamViewerRoleAssignedUserGroup )
         }while ($response.ContinuationToken)

Cmdlets/Public/New-TeamViewerUserRole.ps1 → Cmdlets/Public/New-TeamViewerRole.ps1

@@ -1,13 +1,13 @@
 
-function New-TeamViewerUserRole {
+function New-TeamViewerRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true )]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [Alias('UserRoleName')]
+        [Alias('RoleName')]
         [string]
         $Name,
 
@@ -29,7 +29,7 @@ function New-TeamViewerUserRole {
     }
 
     Process {
-        if ($PSCmdlet.ShouldProcess($Name, 'Create User Role')) {
+        if ($PSCmdlet.ShouldProcess($Name, 'Create Role')) {
             $response = Invoke-TeamViewerRestMethod `
                 -ApiToken $ApiToken `
                 -Uri $resourceUri `
@@ -39,7 +39,7 @@ function New-TeamViewerUserRole {
                 -WriteErrorTo $PSCmdlet `
                 -ErrorAction Stop
 
-            $result = ($response.Role | ConvertTo-TeamViewerUserRole)
+            $result = ($response.Role | ConvertTo-TeamViewerRole)
             Write-Output $result
         }
     }

Cmdlets/Public/Remove-TeamViewerUserRole.ps1 → Cmdlets/Public/Remove-TeamViewerRole.ps1

@@ -1,24 +1,24 @@
-function Remove-TeamViewerUserRole {
+function Remove-TeamViewerRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRole')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('Role')]
         [Alias('Id')]
         [object]
-        $UserRoleId
+        $RoleId
     )
 
     Begin {
-        $resourceUri = "$(Get-TeamViewerApiUri)/userroles?userRoleId=$UserRoleId"
+        $resourceUri = "$(Get-TeamViewerApiUri)/userroles?userRoleId=$RoleId"
     }
 
     Process {
-        if ($PSCmdlet.ShouldProcess($UserRoleId.ToString(), 'Remove User Role')) {
+        if ($PSCmdlet.ShouldProcess($RoleId.ToString(), 'Remove Role')) {
             Invoke-TeamViewerRestMethod `
                 -ApiToken $ApiToken `
                 -Uri $resourceUri `

Cmdlets/Public/Remove-TeamViewerAccountFromUserRole.ps1 → Cmdlets/Public/Remove-TeamViewerUserFromRole.ps1

@@ -1,15 +1,15 @@
-function Remove-TeamViewerAccountFromUserRole {
+function Remove-TeamViewerUserFromRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true)]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRole')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('Role')]
         [object]
-        $UserRoleId,
+        $RoleId,
 
         [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [Alias('Id', 'UserIds')]
@@ -18,13 +18,13 @@ function Remove-TeamViewerAccountFromUserRole {
     )
 
     Begin {
-        $id = $UserRoleId | Resolve-TeamViewerUserRoleId
+        $id = $RoleId | Resolve-TeamViewerRoleId
         $null = $ApiToken
         $resourceUri = "$(Get-TeamViewerApiUri)/userroles/unassign/account"
         $AccountsToRemove = @()
         $body = @{
-            UserIds    = @()
-            UserRoleId = $id
+            UserIds = @()
+            RoleId  = $id
         }
         function Invoke-TeamViewerRestMethodInternal {
             $result = Invoke-TeamViewerRestMethod `

Cmdlets/Public/Remove-TeamViewerUserGroupFromUserRole.ps1 → Cmdlets/Public/Remove-TeamViewerUserGroupFromRole.ps1

@@ -1,4 +1,4 @@
-function Remove-TeamViewerUserGroupFromUserRole {
+function Remove-TeamViewerUserGroupFromRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true)]

Cmdlets/Public/Set-TeamViewerPredefinedRole.ps1

@@ -6,13 +6,13 @@ function Set-TeamViewerPredefinedRole {
         $ApiToken,
 
         [Parameter(Mandatory = $true, ValueFromPipeline = $true )]
-        [ValidateScript({ $_ | Resolve-TeamViewerUserRoleId })]
+        [ValidateScript({ $_ | Resolve-TeamViewerRoleId })]
         [object]
         $RoleId
     )
 
     Process {
-        $Role = $RoleId | Resolve-TeamViewerUserRoleId
+        $Role = $RoleId | Resolve-TeamViewerRoleId
         $resourceUri = "$(Get-TeamViewerApiUri)/userroles/$Role/predefined"
         if ($PSCmdlet.ShouldProcess($Role, 'Set Predefined Role')) {
             Invoke-TeamViewerRestMethod `

Cmdlets/Public/Set-TeamViewerUserRole.ps1 → Cmdlets/Public/Set-TeamViewerRole.ps1

@@ -1,13 +1,13 @@
 
-function Set-TeamViewerUserRole {
+function Set-TeamViewerRole {
     [CmdletBinding(SupportsShouldProcess = $true)]
     param(
         [Parameter(Mandatory = $true )]
         [securestring]
         $ApiToken,
 
         [Parameter(Mandatory = $true)]
-        [Alias('UserRoleName')]
+        [Alias('RoleName')]
         [string]
         $Name,
 
@@ -17,25 +17,25 @@ function Set-TeamViewerUserRole {
         $Permissions,
 
         [Parameter(Mandatory = $true)]
-        [ValidateScript( { $_ | Resolve-TeamViewerUserRoleId } )]
-        [Alias('UserRole')]
+        [ValidateScript( { $_ | Resolve-TeamViewerRoleId } )]
+        [Alias('Role')]
         [object]
-        $UserRoleId
+        $RoleId
     )
     Begin {
         $resourceUri = "$(Get-TeamViewerApiUri)/userroles"
         $body = @{
             Name        = $Name
             Permissions = @()
-            UserRoleId  = $UserRoleId
+            RoleId      = $RoleId
 
         }
         if ($Permissions) {
             $body.Permissions = @($Permissions)
         }
     }
     Process {
-        if ($PSCmdlet.ShouldProcess($Name, 'Update User Role')) {
+        if ($PSCmdlet.ShouldProcess($Name, 'Update Role')) {
             $response = Invoke-TeamViewerRestMethod `
                 -ApiToken $ApiToken `
                 -Uri $resourceUri `

Cmdlets/TeamViewerPS.psd1

@@ -60,7 +60,7 @@
     # NestedModules = @()
 
     # Functions to export from this module.
-    FunctionsToExport = @('Add-TeamViewerAssignment','Add-TeamViewerCustomization','Add-TeamViewerManagedDevice','Add-TeamViewerManager','Add-TeamViewerAccountToUserRole','Add-TeamViewerUserGroupToUserRole','Add-TeamViewerSsoExclusion','Add-TeamViewerUserGroupMember','Connect-TeamViewerApi','Disconnect-TeamViewerApi','Export-TeamViewerSystemInformation','Get-TeamViewerAccount','Get-TeamViewerConnectionReport','Get-TeamViewerContact','Get-TeamViewerCustomModuleId','Get-TeamViewerDevice','Get-TeamViewerEventLog','Get-TeamViewerGroup','Get-TeamViewerId','Get-TeamViewerInstallationDirectory','Get-TeamViewerLogFilePath','Get-TeamViewerManagedDevice','Get-TeamViewerManagedGroup','Get-TeamViewerManagementId','Get-TeamViewerManager','Get-TeamViewerPolicy','Get-TeamViewerPredefinedRole','Get-TeamViewerRoleAssignmentToAccount','Get-TeamViewerRoleAssignmentToUserGroup','Get-TeamViewerService','Get-TeamViewerSsoDomain','Get-TeamViewerSsoExclusion','Get-TeamViewerUser','Get-TeamViewerUserGroup','Get-TeamViewerUserGroupMember','Get-TeamViewerUserRole','Get-TeamViewerVersion','Invoke-TeamViewerPackageDownload','Invoke-TeamViewerPing','New-TeamViewerContact','New-TeamViewerDevice','New-TeamViewerGroup','New-TeamViewerManagedGroup','New-TeamViewerPolicy','New-TeamViewerUser','New-TeamViewerUserGroup','New-TeamViewerUserRole','Publish-TeamViewerGroup','Remove-TeamViewerAssignment','Remove-TeamViewerContact','Remove-TeamViewerCustomization','Remove-TeamViewerDevice','Remove-TeamViewerGroup','Remove-TeamViewerManagedDevice','Remove-TeamViewerManagedDeviceManagement','Remove-TeamViewerManagedGroup','Remove-TeamViewerManager','Remove-TeamViewerPolicy','Remove-TeamViewerPolicyFromManagedDevice','Remove-TeamViewerPredefinedRole','Remove-TeamViewerPSProxy','Remove-TeamViewerAccountFromUserRole','Remove-TeamViewerUserGroupFromUserRole','Remove-TeamViewerSsoExclusion','Remove-TeamViewerUser','Remove-TeamViewerUserGroup','Remove-TeamViewerUserGroupMember','Remove-TeamViewerUserRole','Restart-TeamViewerService','Set-TeamViewerAccount','Set-TeamViewerAPIUri','Set-TeamViewerDevice','Set-TeamViewerGroup','Set-TeamViewerManagedDevice','Set-TeamViewerManagedGroup','Set-TeamViewerManager','Set-TeamViewerPolicy','Set-TeamViewerPredefinedRole','Set-TeamViewerPSProxy','Set-TeamViewerUser','Set-TeamViewerUserGroup','Set-TeamViewerUserRole','Start-TeamViewerService','Stop-TeamViewerService','Test-TeamViewerConnectivity','Test-TeamViewerInstallation','Unpublish-TeamViewerGroup')
+    FunctionsToExport = @('Add-TeamViewerAssignment', 'Add-TeamViewerCustomization', 'Add-TeamViewerManagedDevice', 'Add-TeamViewerManager', 'Add-TeamViewerUserToRole', 'Add-TeamViewerUserGroupToRole', 'Add-TeamViewerSsoExclusion', 'Add-TeamViewerUserGroupMember', 'Connect-TeamViewerApi', 'Disconnect-TeamViewerApi', 'Export-TeamViewerSystemInformation', 'Get-TeamViewerAccount', 'Get-TeamViewerConnectionReport', 'Get-TeamViewerContact', 'Get-TeamViewerCustomModuleId', 'Get-TeamViewerDevice', 'Get-TeamViewerEventLog', 'Get-TeamViewerGroup', 'Get-TeamViewerId', 'Get-TeamViewerInstallationDirectory', 'Get-TeamViewerLogFilePath', 'Get-TeamViewerManagedDevice', 'Get-TeamViewerManagedGroup', 'Get-TeamViewerManagementId', 'Get-TeamViewerManager', 'Get-TeamViewerPolicy', 'Get-TeamViewerPredefinedRole', 'Get-TeamViewerUserByRole', 'Get-TeamViewerUserGroupByRole', 'Get-TeamViewerService', 'Get-TeamViewerSsoDomain', 'Get-TeamViewerSsoExclusion', 'Get-TeamViewerUser', 'Get-TeamViewerUserGroup', 'Get-TeamViewerUserGroupMember', 'Get-TeamViewerRole', 'Get-TeamViewerVersion', 'Invoke-TeamViewerPackageDownload', 'Invoke-TeamViewerPing', 'New-TeamViewerContact', 'New-TeamViewerDevice', 'New-TeamViewerGroup', 'New-TeamViewerManagedGroup', 'New-TeamViewerPolicy', 'New-TeamViewerUser', 'New-TeamViewerUserGroup', 'New-TeamViewerRole', 'Publish-TeamViewerGroup', 'Remove-TeamViewerAssignment', 'Remove-TeamViewerContact', 'Remove-TeamViewerCustomization', 'Remove-TeamViewerDevice', 'Remove-TeamViewerGroup', 'Remove-TeamViewerManagedDevice', 'Remove-TeamViewerManagedDeviceManagement', 'Remove-TeamViewerManagedGroup', 'Remove-TeamViewerManager', 'Remove-TeamViewerPolicy', 'Remove-TeamViewerPolicyFromManagedDevice', 'Remove-TeamViewerPredefinedRole', 'Remove-TeamViewerPSProxy', 'Remove-TeamViewerUserFromRole', 'Remove-TeamViewerUserGroupFromRole', 'Remove-TeamViewerSsoExclusion', 'Remove-TeamViewerUser', 'Remove-TeamViewerUserGroup', 'Remove-TeamViewerUserGroupMember', 'Remove-TeamViewerRole', 'Restart-TeamViewerService', 'Set-TeamViewerAccount', 'Set-TeamViewerAPIUri', 'Set-TeamViewerDevice', 'Set-TeamViewerGroup', 'Set-TeamViewerManagedDevice', 'Set-TeamViewerManagedGroup', 'Set-TeamViewerManager', 'Set-TeamViewerPolicy', 'Set-TeamViewerPredefinedRole', 'Set-TeamViewerPSProxy', 'Set-TeamViewerUser', 'Set-TeamViewerUserGroup', 'Set-TeamViewerRole', 'Start-TeamViewerService', 'Stop-TeamViewerService', 'Test-TeamViewerConnectivity', 'Test-TeamViewerInstallation', 'Unpublish-TeamViewerGroup')
 
     # Cmdlets to export from this module.
     CmdletsToExport   = @()