From 8b5a4fe9a9de47c36590b2d6b775386829d46992 Mon Sep 17 00:00:00 2001 From: Brad Parker Date: Thu, 13 Nov 2025 12:35:41 -0600 Subject: [PATCH 1/3] Refactors module structure and updates manifest This commit reorganizes the module by grouping related functions into logical folders (Access, Cameras, Common, Core, Guest, Helix, Legacy), which improves maintainability and discoverability. Updates the module manifest to reflect the new file structure, correctly export functions, and update metadata. Removes redundant manifest update script, favoring a more comprehensive update approach in the release script. closes #287 --- maintenance/manifestUpdate.ps1 | 4 +- maintenance/release.ps1 | 38 +++++++- maintenance/updateMod.ps1 | 38 +++++++- .../{ => Access}/Add-VerkadaAccessGroup.ps1 | 0 .../Add-VerkadaAccessUserCard.ps1 | 0 .../Add-VerkadaAccessUserLicensePlate.ps1 | 0 .../Add-VerkadaAccessUserMfaCode.ps1 | 0 .../Disable-VerkadaAccessUserCard.ps1 | 0 .../Disable-VerkadaAccessUserLicensePlate.ps1 | 0 .../Enable-VerkadaAccessUserCard.ps1 | 0 .../Enable-VerkadaAccessUserLicensePlate.ps1 | 0 .../{ => Access}/Get-VerkadaAccessEvents.ps1 | 0 .../{ => Access}/Get-VerkadaAccessGroup.ps1 | 0 .../{ => Access}/Get-VerkadaAccessUser.ps1 | 0 .../Get-VerkadaAccessUserProfilePicture.ps1 | 0 .../{ => Access}/Read-VerkadaAccessGroups.ps1 | 0 .../{ => Access}/Read-VerkadaAccessUsers.ps1 | 0 .../Remove-VerkadaAccessGroup.ps1 | 0 .../Remove-VerkadaAccessUserBleUnlock.ps1 | 0 .../Remove-VerkadaAccessUserCard.ps1 | 0 .../Remove-VerkadaAccessUserEntryCode.ps1 | 0 .../Remove-VerkadaAccessUserFromGroup.ps1 | 0 .../Remove-VerkadaAccessUserLicensePlate.ps1 | 0 .../Remove-VerkadaAccessUserMfaCode.ps1 | 0 ...Remove-VerkadaAccessUserProfilePicture.ps1 | 0 .../Remove-VerkadaAccessUserRemoteUnlock.ps1 | 0 .../Send-VerkadaAccessPassInvite.ps1} | 12 +-- .../Set-VerkadaAccessUserBleUnlock.ps1 | 0 .../Set-VerkadaAccessUserEndDate.ps1 | 0 .../Set-VerkadaAccessUserEntryCode.ps1 | 0 .../Set-VerkadaAccessUserGroup.ps1 | 0 .../Set-VerkadaAccessUserProfilePicture.ps1 | 0 .../Set-VerkadaAccessUserRemoteUnlock.ps1 | 0 .../Set-VerkadaAccessUserStartDate.ps1 | 0 .../{ => Access}/Unlock-VerkadaAccessDoor.ps1 | 0 ...dd-VerkadaCameraLicensePlateOfInterest.ps1 | 0 .../Get-VerkadaCameraCloudBackupSettings.ps1 | 0 .../{ => Cameras}/Get-VerkadaCameras.ps1 | 0 .../Get-VerkadaLicensePlatesOfInterest.ps1 | 0 ...ve-VerkadaCameraLicensePlateOfInterest.ps1 | 0 .../Set-VerkadaCameraCloudBackupSettings.ps1 | 0 ...et-VerkadaCameraLicensePlateOfInterest.ps1 | 0 .../Public/{ => Common}/Connect-Verkada.ps1 | 0 .../{ => Common}/Disconnect-Verkada.ps1 | 0 verkadaModule/Public/{ => Common}/Get-Otp.ps1 | 0 .../{ => Core}/Add-VerkadaCommandUser.ps1 | 0 .../{ => Core}/Get-VerkadaCommandUser.ps1 | 2 +- .../{ => Core}/Remove-VerkadaCommandUser.ps1 | 0 .../{ => Core}/Set-VerkadaCommandUser.ps1 | 0 .../{ => Guest}/Read-VerkadaGuestSites.ps1 | 0 .../{ => Helix}/Add-VerkadaHelixEvent.ps1 | 0 .../{ => Helix}/Find-VerkadaHelixEvent.ps1 | 0 .../{ => Helix}/Get-VerkadaHelixEvent.ps1 | 0 .../{ => Helix}/Remove-VerkadaHelixEvent.ps1 | 0 .../{ => Helix}/Set-VerkadaHelixEvent.ps1 | 0 .../Access}/Add-VerkadaAccessSiteAdmin.ps1 | 0 .../Access}/Get-VerkadaAccessCredential.ps1 | 0 .../Get-VerkadaAccessDoorConfigReport.ps1 | 0 .../Get-VerkadaAccessDoorSchedules.ps1 | 0 .../Access}/Get-VerkadaAccessDoors.ps1 | 0 .../Access}/Get-VerkadaAccessLevels.ps1 | 0 .../Access}/Get-VerkadaAccessSite.ps1 | 0 .../Access}/Get-VerkadaAccessUserReport.ps1 | 0 .../Get-VerkadaAccessUserViaGraphql.ps1 | 0 .../Access}/Read-VerkadaAccessEntities.ps1 | 0 .../Access}/Read-VerkadaAccessSchedules.ps1 | 0 .../Access}/Set-VerkadaAccessDoorName.ps1 | 0 .../Set-VerkadaAccessDoorScheduleOverride.ps1 | 0 .../Access}/Set-VerkadaAccessUserEmail.ps1 | 0 ...Set-VerkadaAccessUserEmployementDetail.ps1 | 0 .../Alarms}/Get-VerkadaAlarmsDevices.ps1 | 0 .../Alarms}/Get-VerkadaAlarmsSiteConfig.ps1 | 0 .../Alarms}/Get-VerkadaAlarmsSiteContacts.ps1 | 0 .../Alarms}/Read-VerkadaAlarmsSites.ps1 | 0 .../Set-VerkadaAlarmsDoorSensorSettings.ps1 | 0 .../Set-VerkadaAlarmsPanicButtonSettings.ps1 | 0 .../Cameras}/Add-VerkadaCamera.ps1 | 0 .../Cameras}/Get-VerkadaCameraConfig.ps1 | 0 .../Cameras}/Read-VerkadaCameraArchives.ps1 | 0 .../Cameras}/Remove-VerkadaCameraArchive.ps1 | 0 .../Cameras}/Set-VerkadaCameraName.ps1 | 0 .../Cameras}/Set-VerkadaCameraOrientation.ps1 | 0 .../Set-VerkadaCameraTamperSensitivity.ps1 | 0 .../Core}/Add-VerkadaCommandSite.ps1 | 0 .../Core}/Find-VerkadaCommandUser.ps1 | 0 .../{ => Legacy/Core}/Find-VerkadaUserId.ps1 | 0 .../Core}/Get-VerkadaCameraGroup.ps1 | 0 .../Core}/Read-VerkadaCommandUsers.ps1 | 0 .../Core}/Set-VerkadaCameraSite.ps1 | 0 .../Core}/Set-VerkadaCommandPermissions.ps1 | 0 .../Core}/Set-VerkadaSitePermissions.ps1 | 0 .../Guest}/Add-VerkadaWorkplaceEmployee.ps1 | 0 .../Guest}/Get-VerkadaWorkplaceEmployee.ps1 | 0 .../Guest}/Read-VerkadaWorkplaceEmployees.ps1 | 0 .../Remove-VerkadaWorkplaceEmployee.ps1 | 0 .../Guest}/Set-VerkadaWorkplaceEmployee.ps1 | 0 verkadaModule/verkadaModule.psd1 | 93 ++++++++++--------- 97 files changed, 122 insertions(+), 65 deletions(-) rename verkadaModule/Public/{ => Access}/Add-VerkadaAccessGroup.ps1 (100%) rename verkadaModule/Public/{ => Access}/Add-VerkadaAccessUserCard.ps1 (100%) rename verkadaModule/Public/{ => Access}/Add-VerkadaAccessUserLicensePlate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Add-VerkadaAccessUserMfaCode.ps1 (100%) rename verkadaModule/Public/{ => Access}/Disable-VerkadaAccessUserCard.ps1 (100%) rename verkadaModule/Public/{ => Access}/Disable-VerkadaAccessUserLicensePlate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Enable-VerkadaAccessUserCard.ps1 (100%) rename verkadaModule/Public/{ => Access}/Enable-VerkadaAccessUserLicensePlate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Get-VerkadaAccessEvents.ps1 (100%) rename verkadaModule/Public/{ => Access}/Get-VerkadaAccessGroup.ps1 (100%) rename verkadaModule/Public/{ => Access}/Get-VerkadaAccessUser.ps1 (100%) rename verkadaModule/Public/{ => Access}/Get-VerkadaAccessUserProfilePicture.ps1 (100%) rename verkadaModule/Public/{ => Access}/Read-VerkadaAccessGroups.ps1 (100%) rename verkadaModule/Public/{ => Access}/Read-VerkadaAccessUsers.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessGroup.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserBleUnlock.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserCard.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserEntryCode.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserFromGroup.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserLicensePlate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserMfaCode.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserProfilePicture.ps1 (100%) rename verkadaModule/Public/{ => Access}/Remove-VerkadaAccessUserRemoteUnlock.ps1 (100%) rename verkadaModule/Public/{Send-VerkadaPassInvite.ps1 => Access/Send-VerkadaAccessPassInvite.ps1} (90%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserBleUnlock.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserEndDate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserEntryCode.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserGroup.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserProfilePicture.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserRemoteUnlock.ps1 (100%) rename verkadaModule/Public/{ => Access}/Set-VerkadaAccessUserStartDate.ps1 (100%) rename verkadaModule/Public/{ => Access}/Unlock-VerkadaAccessDoor.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Add-VerkadaCameraLicensePlateOfInterest.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Get-VerkadaCameraCloudBackupSettings.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Get-VerkadaCameras.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Get-VerkadaLicensePlatesOfInterest.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Remove-VerkadaCameraLicensePlateOfInterest.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Set-VerkadaCameraCloudBackupSettings.ps1 (100%) rename verkadaModule/Public/{ => Cameras}/Set-VerkadaCameraLicensePlateOfInterest.ps1 (100%) rename verkadaModule/Public/{ => Common}/Connect-Verkada.ps1 (100%) rename verkadaModule/Public/{ => Common}/Disconnect-Verkada.ps1 (100%) rename verkadaModule/Public/{ => Common}/Get-Otp.ps1 (100%) rename verkadaModule/Public/{ => Core}/Add-VerkadaCommandUser.ps1 (100%) rename verkadaModule/Public/{ => Core}/Get-VerkadaCommandUser.ps1 (97%) rename verkadaModule/Public/{ => Core}/Remove-VerkadaCommandUser.ps1 (100%) rename verkadaModule/Public/{ => Core}/Set-VerkadaCommandUser.ps1 (100%) rename verkadaModule/Public/{ => Guest}/Read-VerkadaGuestSites.ps1 (100%) rename verkadaModule/Public/{ => Helix}/Add-VerkadaHelixEvent.ps1 (100%) rename verkadaModule/Public/{ => Helix}/Find-VerkadaHelixEvent.ps1 (100%) rename verkadaModule/Public/{ => Helix}/Get-VerkadaHelixEvent.ps1 (100%) rename verkadaModule/Public/{ => Helix}/Remove-VerkadaHelixEvent.ps1 (100%) rename verkadaModule/Public/{ => Helix}/Set-VerkadaHelixEvent.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Add-VerkadaAccessSiteAdmin.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessCredential.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessDoorConfigReport.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessDoorSchedules.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessDoors.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessLevels.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessSite.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessUserReport.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Get-VerkadaAccessUserViaGraphql.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Read-VerkadaAccessEntities.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Read-VerkadaAccessSchedules.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Set-VerkadaAccessDoorName.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Set-VerkadaAccessDoorScheduleOverride.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Set-VerkadaAccessUserEmail.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Access}/Set-VerkadaAccessUserEmployementDetail.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Get-VerkadaAlarmsDevices.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Get-VerkadaAlarmsSiteConfig.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Get-VerkadaAlarmsSiteContacts.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Read-VerkadaAlarmsSites.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Set-VerkadaAlarmsDoorSensorSettings.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Alarms}/Set-VerkadaAlarmsPanicButtonSettings.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Add-VerkadaCamera.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Get-VerkadaCameraConfig.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Read-VerkadaCameraArchives.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Remove-VerkadaCameraArchive.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Set-VerkadaCameraName.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Set-VerkadaCameraOrientation.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Cameras}/Set-VerkadaCameraTamperSensitivity.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Add-VerkadaCommandSite.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Find-VerkadaCommandUser.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Find-VerkadaUserId.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Get-VerkadaCameraGroup.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Read-VerkadaCommandUsers.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Set-VerkadaCameraSite.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Set-VerkadaCommandPermissions.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Core}/Set-VerkadaSitePermissions.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Guest}/Add-VerkadaWorkplaceEmployee.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Guest}/Get-VerkadaWorkplaceEmployee.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Guest}/Read-VerkadaWorkplaceEmployees.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Guest}/Remove-VerkadaWorkplaceEmployee.ps1 (100%) rename verkadaModule/Public/{ => Legacy/Guest}/Set-VerkadaWorkplaceEmployee.ps1 (100%) diff --git a/maintenance/manifestUpdate.ps1 b/maintenance/manifestUpdate.ps1 index edab04d..d545786 100644 --- a/maintenance/manifestUpdate.ps1 +++ b/maintenance/manifestUpdate.ps1 @@ -1,6 +1,6 @@ $myMod = 'verkadaModule' $mypath = $PSScriptRoot | Split-Path -Parent import-Module $mypath/$myMod/$myMod.psm1 -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) import-Module $mypath/$myMod/$myMod.psm1 -Force -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) \ No newline at end of file +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) \ No newline at end of file diff --git a/maintenance/release.ps1 b/maintenance/release.ps1 index 2530c94..5264fef 100644 --- a/maintenance/release.ps1 +++ b/maintenance/release.ps1 @@ -1,14 +1,42 @@ $myMod = 'verkadaModule' $mypath = $PSScriptRoot | Split-Path -Parent import-Module $mypath/$myMod/$myMod.psm1 -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) import-Module $mypath/$myMod/$myMod.psm1 -Force -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) -new-MarkdownHelp -Module $myMod -OutputFolder $mypath/docs/function-documentation -Force | Out-Null +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) +Get-ChildItem -Path $mypath/docs/function-documentation -Recurse | Remove-Item -Force -Recurse -Confirm:$false | Out-Null +New-MarkdownHelp -Module $myMod -OutputFolder $mypath/docs/function-documentation -Force | Out-Null -Write-output "# Verkada PowerShell module" | Out-File $mypath/docs/reference.md -Force +Write-output "# Verkada PowerShell module`n" | Out-File $mypath/docs/reference.md -Force Write-output "## Command Documentation" | Out-File $mypath/docs/reference.md -Append -Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName | ForEach-Object {write-output "* [$_](function-documentation/$_.md)"} | Out-File $mypath/docs/reference.md -Append + +Get-ChildItem $mypath/$myMod/Public/ | ForEach-Object { + If(!($_.BaseName -eq 'Legacy')){ + Write-Output "`n### $($_.BaseName)`n" | Out-File $mypath/docs/reference.md -Append + $tempDir=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + if (!(Test-Path -Path "$mypath/docs/function-documentation/$tempDir/" -PathType Container)) { + New-Item -Path "$mypath/docs/function-documentation/$tempDir/" -ItemType Directory -Force + } + Move-Item -Path "$mypath/docs/function-documentation/$($_.BaseName).md" -Destination "$mypath/docs/function-documentation/$tempDir/" -Force + Write-Output "* [$($_.BaseName)](function-documentation/$tempDir/$($_.BaseName).md)" | Out-File $mypath/docs/reference.md -Append + } + } else { + Write-Output `n"### Legacy" | Out-File $mypath/docs/reference.md -Append + $tempDir=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + Write-Output "`n#### Legacy $($_.BaseName)`n" | Out-File $mypath/docs/reference.md -Append + $tempDir2=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + if (!(Test-Path -Path "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -PathType Container)) { + New-Item -Path "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -ItemType Directory -Force + } + Move-Item -Path "$mypath/docs/function-documentation/$($_.BaseName).md" -Destination "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -Force + Write-Output "* [$($_.BaseName)](function-documentation/$tempDir/$tempDir2/$($_.BaseName).md)" | Out-File $mypath/docs/reference.md -Append + } + } + } +} $manifest = Import-PowerShellDataFile "$mypath/$myMod/$myMod.psd1" [version]$version = $Manifest.ModuleVersion diff --git a/maintenance/updateMod.ps1 b/maintenance/updateMod.ps1 index 2530c94..5264fef 100644 --- a/maintenance/updateMod.ps1 +++ b/maintenance/updateMod.ps1 @@ -1,14 +1,42 @@ $myMod = 'verkadaModule' $mypath = $PSScriptRoot | Split-Path -Parent import-Module $mypath/$myMod/$myMod.psm1 -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) import-Module $mypath/$myMod/$myMod.psm1 -Force -update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) -new-MarkdownHelp -Module $myMod -OutputFolder $mypath/docs/function-documentation -Force | Out-Null +update-ModuleManifest -Path "$mypath/$myMod/$myMod.psd1" -FunctionsToExport (Get-ChildItem -Path $mypath/$myMod/Public/ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName) -AliasesToExport (Get-Command -Module verkadaModule | ForEach-Object {Get-Alias -Definition $_.name -ea 0} | Select-Object -ExpandProperty Name) +Get-ChildItem -Path $mypath/docs/function-documentation -Recurse | Remove-Item -Force -Recurse -Confirm:$false | Out-Null +New-MarkdownHelp -Module $myMod -OutputFolder $mypath/docs/function-documentation -Force | Out-Null -Write-output "# Verkada PowerShell module" | Out-File $mypath/docs/reference.md -Force +Write-output "# Verkada PowerShell module`n" | Out-File $mypath/docs/reference.md -Force Write-output "## Command Documentation" | Out-File $mypath/docs/reference.md -Append -Get-ChildItem -Path $mypath/$myMod/Public/*.ps1 -ErrorAction SilentlyContinue | Select-Object -ExpandProperty BaseName | ForEach-Object {write-output "* [$_](function-documentation/$_.md)"} | Out-File $mypath/docs/reference.md -Append + +Get-ChildItem $mypath/$myMod/Public/ | ForEach-Object { + If(!($_.BaseName -eq 'Legacy')){ + Write-Output "`n### $($_.BaseName)`n" | Out-File $mypath/docs/reference.md -Append + $tempDir=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + if (!(Test-Path -Path "$mypath/docs/function-documentation/$tempDir/" -PathType Container)) { + New-Item -Path "$mypath/docs/function-documentation/$tempDir/" -ItemType Directory -Force + } + Move-Item -Path "$mypath/docs/function-documentation/$($_.BaseName).md" -Destination "$mypath/docs/function-documentation/$tempDir/" -Force + Write-Output "* [$($_.BaseName)](function-documentation/$tempDir/$($_.BaseName).md)" | Out-File $mypath/docs/reference.md -Append + } + } else { + Write-Output `n"### Legacy" | Out-File $mypath/docs/reference.md -Append + $tempDir=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + Write-Output "`n#### Legacy $($_.BaseName)`n" | Out-File $mypath/docs/reference.md -Append + $tempDir2=$_.BaseName + Get-ChildItem $_ | ForEach-Object { + if (!(Test-Path -Path "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -PathType Container)) { + New-Item -Path "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -ItemType Directory -Force + } + Move-Item -Path "$mypath/docs/function-documentation/$($_.BaseName).md" -Destination "$mypath/docs/function-documentation/$tempDir/$tempDir2/" -Force + Write-Output "* [$($_.BaseName)](function-documentation/$tempDir/$tempDir2/$($_.BaseName).md)" | Out-File $mypath/docs/reference.md -Append + } + } + } +} $manifest = Import-PowerShellDataFile "$mypath/$myMod/$myMod.psd1" [version]$version = $Manifest.ModuleVersion diff --git a/verkadaModule/Public/Add-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaAccessGroup.ps1 rename to verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 diff --git a/verkadaModule/Public/Add-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaAccessUserCard.ps1 rename to verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 diff --git a/verkadaModule/Public/Add-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaAccessUserLicensePlate.ps1 rename to verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 diff --git a/verkadaModule/Public/Add-VerkadaAccessUserMfaCode.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaAccessUserMfaCode.ps1 rename to verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 diff --git a/verkadaModule/Public/Disable-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 similarity index 100% rename from verkadaModule/Public/Disable-VerkadaAccessUserCard.ps1 rename to verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 diff --git a/verkadaModule/Public/Disable-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 similarity index 100% rename from verkadaModule/Public/Disable-VerkadaAccessUserLicensePlate.ps1 rename to verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 diff --git a/verkadaModule/Public/Enable-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 similarity index 100% rename from verkadaModule/Public/Enable-VerkadaAccessUserCard.ps1 rename to verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 diff --git a/verkadaModule/Public/Enable-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 similarity index 100% rename from verkadaModule/Public/Enable-VerkadaAccessUserLicensePlate.ps1 rename to verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessEvents.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessEvents.ps1 rename to verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessGroup.ps1 rename to verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessUser.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessUser.ps1 rename to verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessUserProfilePicture.ps1 rename to verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 diff --git a/verkadaModule/Public/Read-VerkadaAccessGroups.ps1 b/verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaAccessGroups.ps1 rename to verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 diff --git a/verkadaModule/Public/Read-VerkadaAccessUsers.ps1 b/verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaAccessUsers.ps1 rename to verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessGroup.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserBleUnlock.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserBleUnlock.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserCard.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserEntryCode.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserEntryCode.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserFromGroup.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserFromGroup.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserLicensePlate.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserMfaCode.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserMfaCode.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserProfilePicture.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaAccessUserRemoteUnlock.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaAccessUserRemoteUnlock.ps1 rename to verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 diff --git a/verkadaModule/Public/Send-VerkadaPassInvite.ps1 b/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 similarity index 90% rename from verkadaModule/Public/Send-VerkadaPassInvite.ps1 rename to verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 index ef2be8a..a21c13a 100644 --- a/verkadaModule/Public/Send-VerkadaPassInvite.ps1 +++ b/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 @@ -1,4 +1,4 @@ -function Send-VerkadaPassInvite{ +function Send-VerkadaAccessPassInvite{ <# .SYNOPSIS Send a Verkada Pass email invited to an Access user in an organization using https://apidocs.verkada.com/reference/postsendpassappinviteviewv1 @@ -8,22 +8,22 @@ function Send-VerkadaPassInvite{ The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. .LINK - https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md + https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md .EXAMPLE - Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' + Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE + Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and activate BLE unlocks. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Send-VerkadaPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' This will send an email invite to an Access user with -externalId 'newUserUPN@contoso.com'. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] - [Alias("Send-VrkdaPssInv","sd-VrkdaPssInv")] + [Alias("Send-VrkdaAcPssInv","sd-VrkdaAcPssInv","Send-VrkdaPssInv","sd-VrkdaPssInv","Send-VerkadaPassInvite")] param ( #The UUID of the user [Parameter(ValueFromPipelineByPropertyName = $true)] diff --git a/verkadaModule/Public/Set-VerkadaAccessUserBleUnlock.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserBleUnlock.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserEndDate.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserEndDate.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserEntryCode.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserEntryCode.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserGroup.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserGroup.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserProfilePicture.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserRemoteUnlock.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserRemoteUnlock.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserStartDate.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserStartDate.ps1 rename to verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 diff --git a/verkadaModule/Public/Unlock-VerkadaAccessDoor.ps1 b/verkadaModule/Public/Access/Unlock-VerkadaAccessDoor.ps1 similarity index 100% rename from verkadaModule/Public/Unlock-VerkadaAccessDoor.ps1 rename to verkadaModule/Public/Access/Unlock-VerkadaAccessDoor.ps1 diff --git a/verkadaModule/Public/Add-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaCameraLicensePlateOfInterest.ps1 rename to verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 diff --git a/verkadaModule/Public/Get-VerkadaCameraCloudBackupSettings.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaCameraCloudBackupSettings.ps1 rename to verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 diff --git a/verkadaModule/Public/Get-VerkadaCameras.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaCameras.ps1 rename to verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 diff --git a/verkadaModule/Public/Get-VerkadaLicensePlatesOfInterest.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaLicensePlatesOfInterest.ps1 rename to verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaCameraLicensePlateOfInterest.ps1 rename to verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraCloudBackupSettings.ps1 b/verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraCloudBackupSettings.ps1 rename to verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraLicensePlateOfInterest.ps1 rename to verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 diff --git a/verkadaModule/Public/Connect-Verkada.ps1 b/verkadaModule/Public/Common/Connect-Verkada.ps1 similarity index 100% rename from verkadaModule/Public/Connect-Verkada.ps1 rename to verkadaModule/Public/Common/Connect-Verkada.ps1 diff --git a/verkadaModule/Public/Disconnect-Verkada.ps1 b/verkadaModule/Public/Common/Disconnect-Verkada.ps1 similarity index 100% rename from verkadaModule/Public/Disconnect-Verkada.ps1 rename to verkadaModule/Public/Common/Disconnect-Verkada.ps1 diff --git a/verkadaModule/Public/Get-Otp.ps1 b/verkadaModule/Public/Common/Get-Otp.ps1 similarity index 100% rename from verkadaModule/Public/Get-Otp.ps1 rename to verkadaModule/Public/Common/Get-Otp.ps1 diff --git a/verkadaModule/Public/Add-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaCommandUser.ps1 rename to verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 diff --git a/verkadaModule/Public/Get-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 similarity index 97% rename from verkadaModule/Public/Get-VerkadaCommandUser.ps1 rename to verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 index a8d78ab..f925a05 100644 --- a/verkadaModule/Public/Get-VerkadaCommandUser.ps1 +++ b/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 @@ -1,7 +1,7 @@ function Get-VerkadaCommandUser{ <# .SYNOPSIS - using https://apidocs.verkada.com/reference/getuserviewv1 + Gets a Command user using https://apidocs.verkada.com/reference/getuserviewv1 .DESCRIPTION Returns a user for an organization based on either provided user ID or an external ID set during creation. diff --git a/verkadaModule/Public/Remove-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaCommandUser.ps1 rename to verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCommandUser.ps1 rename to verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 diff --git a/verkadaModule/Public/Read-VerkadaGuestSites.ps1 b/verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaGuestSites.ps1 rename to verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 diff --git a/verkadaModule/Public/Add-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaHelixEvent.ps1 rename to verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 diff --git a/verkadaModule/Public/Find-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 similarity index 100% rename from verkadaModule/Public/Find-VerkadaHelixEvent.ps1 rename to verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 diff --git a/verkadaModule/Public/Get-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaHelixEvent.ps1 rename to verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaHelixEvent.ps1 rename to verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 diff --git a/verkadaModule/Public/Set-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaHelixEvent.ps1 rename to verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 diff --git a/verkadaModule/Public/Add-VerkadaAccessSiteAdmin.ps1 b/verkadaModule/Public/Legacy/Access/Add-VerkadaAccessSiteAdmin.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaAccessSiteAdmin.ps1 rename to verkadaModule/Public/Legacy/Access/Add-VerkadaAccessSiteAdmin.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessCredential.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessCredential.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessCredential.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessCredential.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessDoorConfigReport.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoorConfigReport.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessDoorConfigReport.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoorConfigReport.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessDoorSchedules.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoorSchedules.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessDoorSchedules.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoorSchedules.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessDoors.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoors.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessDoors.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessDoors.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessLevels.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessLevels.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessLevels.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessLevels.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessSite.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessSite.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessSite.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessSite.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessUserReport.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessUserReport.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessUserReport.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessUserReport.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAccessUserViaGraphql.ps1 b/verkadaModule/Public/Legacy/Access/Get-VerkadaAccessUserViaGraphql.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAccessUserViaGraphql.ps1 rename to verkadaModule/Public/Legacy/Access/Get-VerkadaAccessUserViaGraphql.ps1 diff --git a/verkadaModule/Public/Read-VerkadaAccessEntities.ps1 b/verkadaModule/Public/Legacy/Access/Read-VerkadaAccessEntities.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaAccessEntities.ps1 rename to verkadaModule/Public/Legacy/Access/Read-VerkadaAccessEntities.ps1 diff --git a/verkadaModule/Public/Read-VerkadaAccessSchedules.ps1 b/verkadaModule/Public/Legacy/Access/Read-VerkadaAccessSchedules.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaAccessSchedules.ps1 rename to verkadaModule/Public/Legacy/Access/Read-VerkadaAccessSchedules.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessDoorName.ps1 b/verkadaModule/Public/Legacy/Access/Set-VerkadaAccessDoorName.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessDoorName.ps1 rename to verkadaModule/Public/Legacy/Access/Set-VerkadaAccessDoorName.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessDoorScheduleOverride.ps1 b/verkadaModule/Public/Legacy/Access/Set-VerkadaAccessDoorScheduleOverride.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessDoorScheduleOverride.ps1 rename to verkadaModule/Public/Legacy/Access/Set-VerkadaAccessDoorScheduleOverride.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserEmail.ps1 b/verkadaModule/Public/Legacy/Access/Set-VerkadaAccessUserEmail.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserEmail.ps1 rename to verkadaModule/Public/Legacy/Access/Set-VerkadaAccessUserEmail.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAccessUserEmployementDetail.ps1 b/verkadaModule/Public/Legacy/Access/Set-VerkadaAccessUserEmployementDetail.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAccessUserEmployementDetail.ps1 rename to verkadaModule/Public/Legacy/Access/Set-VerkadaAccessUserEmployementDetail.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAlarmsDevices.ps1 b/verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsDevices.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAlarmsDevices.ps1 rename to verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsDevices.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAlarmsSiteConfig.ps1 b/verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsSiteConfig.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAlarmsSiteConfig.ps1 rename to verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsSiteConfig.ps1 diff --git a/verkadaModule/Public/Get-VerkadaAlarmsSiteContacts.ps1 b/verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsSiteContacts.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaAlarmsSiteContacts.ps1 rename to verkadaModule/Public/Legacy/Alarms/Get-VerkadaAlarmsSiteContacts.ps1 diff --git a/verkadaModule/Public/Read-VerkadaAlarmsSites.ps1 b/verkadaModule/Public/Legacy/Alarms/Read-VerkadaAlarmsSites.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaAlarmsSites.ps1 rename to verkadaModule/Public/Legacy/Alarms/Read-VerkadaAlarmsSites.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAlarmsDoorSensorSettings.ps1 b/verkadaModule/Public/Legacy/Alarms/Set-VerkadaAlarmsDoorSensorSettings.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAlarmsDoorSensorSettings.ps1 rename to verkadaModule/Public/Legacy/Alarms/Set-VerkadaAlarmsDoorSensorSettings.ps1 diff --git a/verkadaModule/Public/Set-VerkadaAlarmsPanicButtonSettings.ps1 b/verkadaModule/Public/Legacy/Alarms/Set-VerkadaAlarmsPanicButtonSettings.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaAlarmsPanicButtonSettings.ps1 rename to verkadaModule/Public/Legacy/Alarms/Set-VerkadaAlarmsPanicButtonSettings.ps1 diff --git a/verkadaModule/Public/Add-VerkadaCamera.ps1 b/verkadaModule/Public/Legacy/Cameras/Add-VerkadaCamera.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaCamera.ps1 rename to verkadaModule/Public/Legacy/Cameras/Add-VerkadaCamera.ps1 diff --git a/verkadaModule/Public/Get-VerkadaCameraConfig.ps1 b/verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaCameraConfig.ps1 rename to verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 diff --git a/verkadaModule/Public/Read-VerkadaCameraArchives.ps1 b/verkadaModule/Public/Legacy/Cameras/Read-VerkadaCameraArchives.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaCameraArchives.ps1 rename to verkadaModule/Public/Legacy/Cameras/Read-VerkadaCameraArchives.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaCameraArchive.ps1 b/verkadaModule/Public/Legacy/Cameras/Remove-VerkadaCameraArchive.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaCameraArchive.ps1 rename to verkadaModule/Public/Legacy/Cameras/Remove-VerkadaCameraArchive.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraName.ps1 b/verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraName.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraName.ps1 rename to verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraName.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraOrientation.ps1 b/verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraOrientation.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraOrientation.ps1 rename to verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraOrientation.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraTamperSensitivity.ps1 b/verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraTamperSensitivity.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraTamperSensitivity.ps1 rename to verkadaModule/Public/Legacy/Cameras/Set-VerkadaCameraTamperSensitivity.ps1 diff --git a/verkadaModule/Public/Add-VerkadaCommandSite.ps1 b/verkadaModule/Public/Legacy/Core/Add-VerkadaCommandSite.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaCommandSite.ps1 rename to verkadaModule/Public/Legacy/Core/Add-VerkadaCommandSite.ps1 diff --git a/verkadaModule/Public/Find-VerkadaCommandUser.ps1 b/verkadaModule/Public/Legacy/Core/Find-VerkadaCommandUser.ps1 similarity index 100% rename from verkadaModule/Public/Find-VerkadaCommandUser.ps1 rename to verkadaModule/Public/Legacy/Core/Find-VerkadaCommandUser.ps1 diff --git a/verkadaModule/Public/Find-VerkadaUserId.ps1 b/verkadaModule/Public/Legacy/Core/Find-VerkadaUserId.ps1 similarity index 100% rename from verkadaModule/Public/Find-VerkadaUserId.ps1 rename to verkadaModule/Public/Legacy/Core/Find-VerkadaUserId.ps1 diff --git a/verkadaModule/Public/Get-VerkadaCameraGroup.ps1 b/verkadaModule/Public/Legacy/Core/Get-VerkadaCameraGroup.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaCameraGroup.ps1 rename to verkadaModule/Public/Legacy/Core/Get-VerkadaCameraGroup.ps1 diff --git a/verkadaModule/Public/Read-VerkadaCommandUsers.ps1 b/verkadaModule/Public/Legacy/Core/Read-VerkadaCommandUsers.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaCommandUsers.ps1 rename to verkadaModule/Public/Legacy/Core/Read-VerkadaCommandUsers.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCameraSite.ps1 b/verkadaModule/Public/Legacy/Core/Set-VerkadaCameraSite.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCameraSite.ps1 rename to verkadaModule/Public/Legacy/Core/Set-VerkadaCameraSite.ps1 diff --git a/verkadaModule/Public/Set-VerkadaCommandPermissions.ps1 b/verkadaModule/Public/Legacy/Core/Set-VerkadaCommandPermissions.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaCommandPermissions.ps1 rename to verkadaModule/Public/Legacy/Core/Set-VerkadaCommandPermissions.ps1 diff --git a/verkadaModule/Public/Set-VerkadaSitePermissions.ps1 b/verkadaModule/Public/Legacy/Core/Set-VerkadaSitePermissions.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaSitePermissions.ps1 rename to verkadaModule/Public/Legacy/Core/Set-VerkadaSitePermissions.ps1 diff --git a/verkadaModule/Public/Add-VerkadaWorkplaceEmployee.ps1 b/verkadaModule/Public/Legacy/Guest/Add-VerkadaWorkplaceEmployee.ps1 similarity index 100% rename from verkadaModule/Public/Add-VerkadaWorkplaceEmployee.ps1 rename to verkadaModule/Public/Legacy/Guest/Add-VerkadaWorkplaceEmployee.ps1 diff --git a/verkadaModule/Public/Get-VerkadaWorkplaceEmployee.ps1 b/verkadaModule/Public/Legacy/Guest/Get-VerkadaWorkplaceEmployee.ps1 similarity index 100% rename from verkadaModule/Public/Get-VerkadaWorkplaceEmployee.ps1 rename to verkadaModule/Public/Legacy/Guest/Get-VerkadaWorkplaceEmployee.ps1 diff --git a/verkadaModule/Public/Read-VerkadaWorkplaceEmployees.ps1 b/verkadaModule/Public/Legacy/Guest/Read-VerkadaWorkplaceEmployees.ps1 similarity index 100% rename from verkadaModule/Public/Read-VerkadaWorkplaceEmployees.ps1 rename to verkadaModule/Public/Legacy/Guest/Read-VerkadaWorkplaceEmployees.ps1 diff --git a/verkadaModule/Public/Remove-VerkadaWorkplaceEmployee.ps1 b/verkadaModule/Public/Legacy/Guest/Remove-VerkadaWorkplaceEmployee.ps1 similarity index 100% rename from verkadaModule/Public/Remove-VerkadaWorkplaceEmployee.ps1 rename to verkadaModule/Public/Legacy/Guest/Remove-VerkadaWorkplaceEmployee.ps1 diff --git a/verkadaModule/Public/Set-VerkadaWorkplaceEmployee.ps1 b/verkadaModule/Public/Legacy/Guest/Set-VerkadaWorkplaceEmployee.ps1 similarity index 100% rename from verkadaModule/Public/Set-VerkadaWorkplaceEmployee.ps1 rename to verkadaModule/Public/Legacy/Guest/Set-VerkadaWorkplaceEmployee.ps1 diff --git a/verkadaModule/verkadaModule.psd1 b/verkadaModule/verkadaModule.psd1 index dc816fc..98442be 100644 --- a/verkadaModule/verkadaModule.psd1 +++ b/verkadaModule/verkadaModule.psd1 @@ -3,7 +3,7 @@ # # Generated by: Verkada SE Community # -# Generated on: 10/24/2025 +# Generated on: 11/13/2025 # @{ @@ -69,62 +69,62 @@ PowerShellVersion = '6.1' # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = 'Add-VerkadaAccessGroup', 'Add-VerkadaAccessSiteAdmin', - 'Add-VerkadaAccessUserCard', 'Add-VerkadaAccessUserLicensePlate', - 'Add-VerkadaAccessUserMfaCode', 'Add-VerkadaCamera', - 'Add-VerkadaCameraLicensePlateOfInterest', 'Add-VerkadaCommandSite', - 'Add-VerkadaCommandUser', 'Add-VerkadaHelixEvent', - 'Add-VerkadaWorkplaceEmployee', 'Connect-Verkada', +FunctionsToExport = 'Add-VerkadaAccessGroup', 'Add-VerkadaAccessUserCard', + 'Add-VerkadaAccessUserLicensePlate', 'Add-VerkadaAccessUserMfaCode', 'Disable-VerkadaAccessUserCard', - 'Disable-VerkadaAccessUserLicensePlate', 'Disconnect-Verkada', + 'Disable-VerkadaAccessUserLicensePlate', 'Enable-VerkadaAccessUserCard', - 'Enable-VerkadaAccessUserLicensePlate', 'Find-VerkadaCommandUser', - 'Find-VerkadaHelixEvent', 'Find-VerkadaUserId', 'Get-Otp', - 'Get-VerkadaAccessCredential', 'Get-VerkadaAccessDoorConfigReport', - 'Get-VerkadaAccessDoors', 'Get-VerkadaAccessDoorSchedules', - 'Get-VerkadaAccessEvents', 'Get-VerkadaAccessGroup', - 'Get-VerkadaAccessLevels', 'Get-VerkadaAccessSite', - 'Get-VerkadaAccessUser', 'Get-VerkadaAccessUserProfilePicture', - 'Get-VerkadaAccessUserReport', 'Get-VerkadaAccessUserViaGraphql', - 'Get-VerkadaAlarmsDevices', 'Get-VerkadaAlarmsSiteConfig', - 'Get-VerkadaAlarmsSiteContacts', - 'Get-VerkadaCameraCloudBackupSettings', 'Get-VerkadaCameraConfig', - 'Get-VerkadaCameraGroup', 'Get-VerkadaCameras', - 'Get-VerkadaCommandUser', 'Get-VerkadaHelixEvent', - 'Get-VerkadaLicensePlatesOfInterest', - 'Get-VerkadaWorkplaceEmployee', 'Read-VerkadaAccessEntities', - 'Read-VerkadaAccessGroups', 'Read-VerkadaAccessSchedules', - 'Read-VerkadaAccessUsers', 'Read-VerkadaAlarmsSites', - 'Read-VerkadaCameraArchives', 'Read-VerkadaCommandUsers', - 'Read-VerkadaGuestSites', 'Read-VerkadaWorkplaceEmployees', - 'Remove-VerkadaAccessGroup', 'Remove-VerkadaAccessUserBleUnlock', - 'Remove-VerkadaAccessUserCard', 'Remove-VerkadaAccessUserEntryCode', + 'Enable-VerkadaAccessUserLicensePlate', 'Get-VerkadaAccessEvents', + 'Get-VerkadaAccessGroup', 'Get-VerkadaAccessUser', + 'Get-VerkadaAccessUserProfilePicture', 'Read-VerkadaAccessGroups', + 'Read-VerkadaAccessUsers', 'Remove-VerkadaAccessGroup', + 'Remove-VerkadaAccessUserBleUnlock', 'Remove-VerkadaAccessUserCard', + 'Remove-VerkadaAccessUserEntryCode', 'Remove-VerkadaAccessUserFromGroup', 'Remove-VerkadaAccessUserLicensePlate', 'Remove-VerkadaAccessUserMfaCode', 'Remove-VerkadaAccessUserProfilePicture', 'Remove-VerkadaAccessUserRemoteUnlock', - 'Remove-VerkadaCameraArchive', + 'Send-VerkadaAccessPassInvite', 'Set-VerkadaAccessUserBleUnlock', + 'Set-VerkadaAccessUserEndDate', 'Set-VerkadaAccessUserEntryCode', + 'Set-VerkadaAccessUserGroup', 'Set-VerkadaAccessUserProfilePicture', + 'Set-VerkadaAccessUserRemoteUnlock', + 'Set-VerkadaAccessUserStartDate', 'Unlock-VerkadaAccessDoor', + 'Add-VerkadaCameraLicensePlateOfInterest', + 'Get-VerkadaCameraCloudBackupSettings', 'Get-VerkadaCameras', + 'Get-VerkadaLicensePlatesOfInterest', 'Remove-VerkadaCameraLicensePlateOfInterest', - 'Remove-VerkadaCommandUser', 'Remove-VerkadaHelixEvent', - 'Remove-VerkadaWorkplaceEmployee', 'Send-VerkadaPassInvite', + 'Set-VerkadaCameraCloudBackupSettings', + 'Set-VerkadaCameraLicensePlateOfInterest', 'Connect-Verkada', + 'Disconnect-Verkada', 'Get-Otp', 'Add-VerkadaCommandUser', + 'Get-VerkadaCommandUser', 'Remove-VerkadaCommandUser', + 'Set-VerkadaCommandUser', 'Read-VerkadaGuestSites', + 'Add-VerkadaHelixEvent', 'Find-VerkadaHelixEvent', + 'Get-VerkadaHelixEvent', 'Remove-VerkadaHelixEvent', + 'Set-VerkadaHelixEvent', 'Add-VerkadaAccessSiteAdmin', + 'Get-VerkadaAccessCredential', 'Get-VerkadaAccessDoorConfigReport', + 'Get-VerkadaAccessDoors', 'Get-VerkadaAccessDoorSchedules', + 'Get-VerkadaAccessLevels', 'Get-VerkadaAccessSite', + 'Get-VerkadaAccessUserReport', 'Get-VerkadaAccessUserViaGraphql', + 'Read-VerkadaAccessEntities', 'Read-VerkadaAccessSchedules', 'Set-VerkadaAccessDoorName', 'Set-VerkadaAccessDoorScheduleOverride', - 'Set-VerkadaAccessUserBleUnlock', 'Set-VerkadaAccessUserEmail', + 'Set-VerkadaAccessUserEmail', 'Set-VerkadaAccessUserEmployementDetail', - 'Set-VerkadaAccessUserEndDate', 'Set-VerkadaAccessUserEntryCode', - 'Set-VerkadaAccessUserGroup', 'Set-VerkadaAccessUserProfilePicture', - 'Set-VerkadaAccessUserRemoteUnlock', - 'Set-VerkadaAccessUserStartDate', + 'Get-VerkadaAlarmsDevices', 'Get-VerkadaAlarmsSiteConfig', + 'Get-VerkadaAlarmsSiteContacts', 'Read-VerkadaAlarmsSites', 'Set-VerkadaAlarmsDoorSensorSettings', - 'Set-VerkadaAlarmsPanicButtonSettings', - 'Set-VerkadaCameraCloudBackupSettings', - 'Set-VerkadaCameraLicensePlateOfInterest', 'Set-VerkadaCameraName', - 'Set-VerkadaCameraOrientation', 'Set-VerkadaCameraSite', - 'Set-VerkadaCameraTamperSensitivity', - 'Set-VerkadaCommandPermissions', 'Set-VerkadaCommandUser', - 'Set-VerkadaHelixEvent', 'Set-VerkadaSitePermissions', - 'Set-VerkadaWorkplaceEmployee', 'Unlock-VerkadaAccessDoor' + 'Set-VerkadaAlarmsPanicButtonSettings', 'Add-VerkadaCamera', + 'Get-VerkadaCameraConfig', 'Read-VerkadaCameraArchives', + 'Remove-VerkadaCameraArchive', 'Set-VerkadaCameraName', + 'Set-VerkadaCameraOrientation', + 'Set-VerkadaCameraTamperSensitivity', 'Add-VerkadaCommandSite', + 'Find-VerkadaCommandUser', 'Find-VerkadaUserId', + 'Get-VerkadaCameraGroup', 'Read-VerkadaCommandUsers', + 'Set-VerkadaCameraSite', 'Set-VerkadaCommandPermissions', + 'Set-VerkadaSitePermissions', 'Add-VerkadaWorkplaceEmployee', + 'Get-VerkadaWorkplaceEmployee', 'Read-VerkadaWorkplaceEmployees', + 'Remove-VerkadaWorkplaceEmployee', 'Set-VerkadaWorkplaceEmployee' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() @@ -166,7 +166,8 @@ AliasesToExport = 'a-VrkdaAcGrp', 'Add-VrkdaAcGrp', 'a-VrkdaAcUsrCrd', 'Remove-VerkadaLicensePlateOfInterest', 'Remove-VerkadaLPoI', 'Remove-VrkdaLPoI', 'rm-VrkdaLPoI', 'Remove-VrkdaCmdUsr', 'rm-VrkdaCmdUsr', 'Remove-VrkdaHlxEvt', 'rm-VrkdaHlxEvt', - 'Remove-VrkdaWrkEmp', 'rm-VrkdaWrkEmp', 'sd-VrkdaPssInv', + 'Remove-VrkdaWrkEmp', 'rm-VrkdaWrkEmp', 'sd-VrkdaAcPssInv', + 'sd-VrkdaPssInv', 'Send-VerkadaPassInvite', 'Send-VrkdaAcPssInv', 'Send-VrkdaPssInv', 'Set-VrkdaAcDrNm', 'st-VrkdaAcDrNm', 's-VrkdAcDrSchOvrd', 'Set-VrkdAcDrSchOvrd', 'Set-VrkdaAcUsrBtUnlk', 'st-VrkdaAcUsrBtUnlk', 'Set-VrkdaAcUsrEndDt', 'st-VrkdaAcUsrEndDt', From b6938591c2bc22db32456e6ac4c5ccfe1734076b Mon Sep 17 00:00:00 2001 From: Brad Parker Date: Thu, 13 Nov 2025 12:36:12 -0600 Subject: [PATCH 2/3] Updates Public script loading to recurse Updates the public script loading to recursively search the Public directory for all .ps1 files. This allows for better organization of public functions into subdirectories. Related to 287-reorganize-module-into-logical-folde --- verkadaModule/verkadaModule.psm1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/verkadaModule/verkadaModule.psm1 b/verkadaModule/verkadaModule.psm1 index 2b03a70..f11f72e 100644 --- a/verkadaModule/verkadaModule.psm1 +++ b/verkadaModule/verkadaModule.psm1 @@ -1,5 +1,5 @@ #Get public and private function definition files. - $Public = @( Get-ChildItem -Path $PSScriptRoot\Public\*.ps1 -ErrorAction SilentlyContinue ) + $Public = @( Get-ChildItem -Path $PSScriptRoot\Public\ -Recurse -Include *.ps1 -ErrorAction SilentlyContinue ) $Private = @( Get-ChildItem -Path $PSScriptRoot\Private\*.ps1 -ErrorAction SilentlyContinue ) #Dot source the files From 652c36003923930b02cb32c0008ad263eb59c9fe Mon Sep 17 00:00:00 2001 From: bepsoccer <26012546+bepsoccer@users.noreply.github.com> Date: Thu, 13 Nov 2025 18:40:21 +0000 Subject: [PATCH 3/3] Bumping release to /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Access /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Cameras /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Common /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Core /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Guest /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Helix /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Legacy/Access /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Legacy/Alarms /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Legacy/Cameras /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Legacy/Core /home/runner/work/verkadaModule/verkadaModule/docs/function-documentation/Legacy/Guest 0.10.1 --- .../{ => Access}/Add-VerkadaAccessGroup.md | 0 .../{ => Access}/Add-VerkadaAccessUserCard.md | 0 .../Add-VerkadaAccessUserLicensePlate.md | 0 .../Add-VerkadaAccessUserMfaCode.md | 0 .../Disable-VerkadaAccessUserCard.md | 0 .../Disable-VerkadaAccessUserLicensePlate.md | 0 .../Enable-VerkadaAccessUserCard.md | 0 .../Enable-VerkadaAccessUserLicensePlate.md | 0 .../{ => Access}/Get-VerkadaAccessEvents.md | 0 .../{ => Access}/Get-VerkadaAccessGroup.md | 0 .../{ => Access}/Get-VerkadaAccessUser.md | 0 .../Get-VerkadaAccessUserProfilePicture.md | 0 .../{ => Access}/Read-VerkadaAccessGroups.md | 0 .../{ => Access}/Read-VerkadaAccessUsers.md | 0 .../{ => Access}/Remove-VerkadaAccessGroup.md | 0 .../Remove-VerkadaAccessUserBleUnlock.md | 0 .../Remove-VerkadaAccessUserCard.md | 0 .../Remove-VerkadaAccessUserEntryCode.md | 0 .../Remove-VerkadaAccessUserFromGroup.md | 0 .../Remove-VerkadaAccessUserLicensePlate.md | 0 .../Remove-VerkadaAccessUserMfaCode.md | 0 .../Remove-VerkadaAccessUserProfilePicture.md | 0 .../Remove-VerkadaAccessUserRemoteUnlock.md | 0 .../Send-VerkadaAccessPassInvite.md} | 14 +- .../Set-VerkadaAccessUserBleUnlock.md | 0 .../Set-VerkadaAccessUserEndDate.md | 0 .../Set-VerkadaAccessUserEntryCode.md | 0 .../Set-VerkadaAccessUserGroup.md | 0 .../Set-VerkadaAccessUserProfilePicture.md | 0 .../Set-VerkadaAccessUserRemoteUnlock.md | 0 .../Set-VerkadaAccessUserStartDate.md | 0 .../{ => Access}/Unlock-VerkadaAccessDoor.md | 0 .../Add-VerkadaLicensePlateOfInterest.md | 139 ----------- ...Add-VerkadaCameraLicensePlateOfInterest.md | 0 .../Get-VerkadaCameraCloudBackupSettings.md | 0 .../{ => Cameras}/Get-VerkadaCameras.md | 0 .../Get-VerkadaLicensePlatesOfInterest.md | 0 ...ove-VerkadaCameraLicensePlateOfInterest.md | 0 .../Set-VerkadaCameraCloudBackupSettings.md | 0 ...Set-VerkadaCameraLicensePlateOfInterest.md | 0 .../{ => Common}/Connect-Verkada.md | 0 .../{ => Common}/Disconnect-Verkada.md | 0 .../{ => Common}/Get-Otp.md | 0 .../{ => Core}/Add-VerkadaCommandUser.md | 0 .../{ => Core}/Get-VerkadaCommandUser.md | 2 +- .../{ => Core}/Remove-VerkadaCommandUser.md | 0 .../{ => Core}/Set-VerkadaCommandUser.md | 0 .../Get-VerkadaCloudBackupSettings.md | 149 ----------- .../{ => Guest}/Read-VerkadaGuestSites.md | 0 .../{ => Helix}/Add-VerkadaHelixEvent.md | 0 .../{ => Helix}/Find-VerkadaHelixEvent.md | 0 .../{ => Helix}/Get-VerkadaHelixEvent.md | 0 .../{ => Helix}/Remove-VerkadaHelixEvent.md | 0 .../{ => Helix}/Set-VerkadaHelixEvent.md | 0 .../Access}/Add-VerkadaAccessSiteAdmin.md | 0 .../Access}/Get-VerkadaAccessCredential.md | 0 .../Get-VerkadaAccessDoorConfigReport.md | 0 .../Access}/Get-VerkadaAccessDoorSchedules.md | 0 .../Access}/Get-VerkadaAccessDoors.md | 0 .../Access}/Get-VerkadaAccessLevels.md | 0 .../Access}/Get-VerkadaAccessSite.md | 0 .../Access}/Get-VerkadaAccessUserReport.md | 0 .../Get-VerkadaAccessUserViaGraphql.md | 0 .../Access}/Read-VerkadaAccessEntities.md | 0 .../Access}/Read-VerkadaAccessSchedules.md | 0 .../Access}/Set-VerkadaAccessDoorName.md | 0 .../Set-VerkadaAccessDoorScheduleOverride.md | 0 .../Access}/Set-VerkadaAccessUserEmail.md | 0 .../Set-VerkadaAccessUserEmployementDetail.md | 0 .../Alarms}/Get-VerkadaAlarmsDevices.md | 0 .../Alarms}/Get-VerkadaAlarmsSiteConfig.md | 0 .../Alarms}/Get-VerkadaAlarmsSiteContacts.md | 0 .../Alarms}/Read-VerkadaAlarmsSites.md | 0 .../Set-VerkadaAlarmsDoorSensorSettings.md | 0 .../Set-VerkadaAlarmsPanicButtonSettings.md | 0 .../{ => Legacy/Cameras}/Add-VerkadaCamera.md | 0 .../Cameras}/Get-VerkadaCameraConfig.md | 0 .../Cameras}/Read-VerkadaCameraArchives.md | 0 .../Cameras}/Remove-VerkadaCameraArchive.md | 0 .../Cameras}/Set-VerkadaCameraName.md | 0 .../Cameras}/Set-VerkadaCameraOrientation.md | 0 .../Set-VerkadaCameraTamperSensitivity.md | 0 .../Core}/Add-VerkadaCommandSite.md | 0 .../Core}/Find-VerkadaCommandUser.md | 0 .../{ => Legacy/Core}/Find-VerkadaUserId.md | 0 .../Core}/Get-VerkadaCameraGroup.md | 0 .../Core}/Read-VerkadaCommandUsers.md | 0 .../Core}/Set-VerkadaCameraSite.md | 0 .../Core}/Set-VerkadaCommandPermissions.md | 0 .../Core}/Set-VerkadaSitePermissions.md | 0 .../Guest}/Add-VerkadaWorkplaceEmployee.md | 0 .../Guest}/Get-VerkadaWorkplaceEmployee.md | 0 .../Guest}/Read-VerkadaWorkplaceEmployees.md | 0 .../Guest}/Remove-VerkadaWorkplaceEmployee.md | 0 .../Guest}/Set-VerkadaWorkplaceEmployee.md | 0 .../Remove-VerkadaLicensePlateOfInterest.md | 124 ---------- .../Set-VerkadaCloudBackupSettings.md | 233 ------------------ .../Set-VerkadaLicensePlateOfInterest.md | 139 ----------- docs/reference.md | 222 ++++++++++------- verkadaModule/verkadaModule.psd1 | 2 +- 100 files changed, 138 insertions(+), 886 deletions(-) rename docs/function-documentation/{ => Access}/Add-VerkadaAccessGroup.md (100%) rename docs/function-documentation/{ => Access}/Add-VerkadaAccessUserCard.md (100%) rename docs/function-documentation/{ => Access}/Add-VerkadaAccessUserLicensePlate.md (100%) rename docs/function-documentation/{ => Access}/Add-VerkadaAccessUserMfaCode.md (100%) rename docs/function-documentation/{ => Access}/Disable-VerkadaAccessUserCard.md (100%) rename docs/function-documentation/{ => Access}/Disable-VerkadaAccessUserLicensePlate.md (100%) rename docs/function-documentation/{ => Access}/Enable-VerkadaAccessUserCard.md (100%) rename docs/function-documentation/{ => Access}/Enable-VerkadaAccessUserLicensePlate.md (100%) rename docs/function-documentation/{ => Access}/Get-VerkadaAccessEvents.md (100%) rename docs/function-documentation/{ => Access}/Get-VerkadaAccessGroup.md (100%) rename docs/function-documentation/{ => Access}/Get-VerkadaAccessUser.md (100%) rename docs/function-documentation/{ => Access}/Get-VerkadaAccessUserProfilePicture.md (100%) rename docs/function-documentation/{ => Access}/Read-VerkadaAccessGroups.md (100%) rename docs/function-documentation/{ => Access}/Read-VerkadaAccessUsers.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessGroup.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserBleUnlock.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserCard.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserEntryCode.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserFromGroup.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserLicensePlate.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserMfaCode.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserProfilePicture.md (100%) rename docs/function-documentation/{ => Access}/Remove-VerkadaAccessUserRemoteUnlock.md (100%) rename docs/function-documentation/{Send-VerkadaPassInvite.md => Access/Send-VerkadaAccessPassInvite.md} (81%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserBleUnlock.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserEndDate.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserEntryCode.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserGroup.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserProfilePicture.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserRemoteUnlock.md (100%) rename docs/function-documentation/{ => Access}/Set-VerkadaAccessUserStartDate.md (100%) rename docs/function-documentation/{ => Access}/Unlock-VerkadaAccessDoor.md (100%) delete mode 100644 docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md rename docs/function-documentation/{ => Cameras}/Add-VerkadaCameraLicensePlateOfInterest.md (100%) rename docs/function-documentation/{ => Cameras}/Get-VerkadaCameraCloudBackupSettings.md (100%) rename docs/function-documentation/{ => Cameras}/Get-VerkadaCameras.md (100%) rename docs/function-documentation/{ => Cameras}/Get-VerkadaLicensePlatesOfInterest.md (100%) rename docs/function-documentation/{ => Cameras}/Remove-VerkadaCameraLicensePlateOfInterest.md (100%) rename docs/function-documentation/{ => Cameras}/Set-VerkadaCameraCloudBackupSettings.md (100%) rename docs/function-documentation/{ => Cameras}/Set-VerkadaCameraLicensePlateOfInterest.md (100%) rename docs/function-documentation/{ => Common}/Connect-Verkada.md (100%) rename docs/function-documentation/{ => Common}/Disconnect-Verkada.md (100%) rename docs/function-documentation/{ => Common}/Get-Otp.md (100%) rename docs/function-documentation/{ => Core}/Add-VerkadaCommandUser.md (100%) rename docs/function-documentation/{ => Core}/Get-VerkadaCommandUser.md (94%) rename docs/function-documentation/{ => Core}/Remove-VerkadaCommandUser.md (100%) rename docs/function-documentation/{ => Core}/Set-VerkadaCommandUser.md (100%) delete mode 100644 docs/function-documentation/Get-VerkadaCloudBackupSettings.md rename docs/function-documentation/{ => Guest}/Read-VerkadaGuestSites.md (100%) rename docs/function-documentation/{ => Helix}/Add-VerkadaHelixEvent.md (100%) rename docs/function-documentation/{ => Helix}/Find-VerkadaHelixEvent.md (100%) rename docs/function-documentation/{ => Helix}/Get-VerkadaHelixEvent.md (100%) rename docs/function-documentation/{ => Helix}/Remove-VerkadaHelixEvent.md (100%) rename docs/function-documentation/{ => Helix}/Set-VerkadaHelixEvent.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Add-VerkadaAccessSiteAdmin.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessCredential.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessDoorConfigReport.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessDoorSchedules.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessDoors.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessLevels.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessSite.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessUserReport.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Get-VerkadaAccessUserViaGraphql.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Read-VerkadaAccessEntities.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Read-VerkadaAccessSchedules.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Set-VerkadaAccessDoorName.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Set-VerkadaAccessDoorScheduleOverride.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Set-VerkadaAccessUserEmail.md (100%) rename docs/function-documentation/{ => Legacy/Access}/Set-VerkadaAccessUserEmployementDetail.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Get-VerkadaAlarmsDevices.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Get-VerkadaAlarmsSiteConfig.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Get-VerkadaAlarmsSiteContacts.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Read-VerkadaAlarmsSites.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Set-VerkadaAlarmsDoorSensorSettings.md (100%) rename docs/function-documentation/{ => Legacy/Alarms}/Set-VerkadaAlarmsPanicButtonSettings.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Add-VerkadaCamera.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Get-VerkadaCameraConfig.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Read-VerkadaCameraArchives.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Remove-VerkadaCameraArchive.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Set-VerkadaCameraName.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Set-VerkadaCameraOrientation.md (100%) rename docs/function-documentation/{ => Legacy/Cameras}/Set-VerkadaCameraTamperSensitivity.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Add-VerkadaCommandSite.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Find-VerkadaCommandUser.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Find-VerkadaUserId.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Get-VerkadaCameraGroup.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Read-VerkadaCommandUsers.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Set-VerkadaCameraSite.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Set-VerkadaCommandPermissions.md (100%) rename docs/function-documentation/{ => Legacy/Core}/Set-VerkadaSitePermissions.md (100%) rename docs/function-documentation/{ => Legacy/Guest}/Add-VerkadaWorkplaceEmployee.md (100%) rename docs/function-documentation/{ => Legacy/Guest}/Get-VerkadaWorkplaceEmployee.md (100%) rename docs/function-documentation/{ => Legacy/Guest}/Read-VerkadaWorkplaceEmployees.md (100%) rename docs/function-documentation/{ => Legacy/Guest}/Remove-VerkadaWorkplaceEmployee.md (100%) rename docs/function-documentation/{ => Legacy/Guest}/Set-VerkadaWorkplaceEmployee.md (100%) delete mode 100644 docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md delete mode 100644 docs/function-documentation/Set-VerkadaCloudBackupSettings.md delete mode 100644 docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md diff --git a/docs/function-documentation/Add-VerkadaAccessGroup.md b/docs/function-documentation/Access/Add-VerkadaAccessGroup.md similarity index 100% rename from docs/function-documentation/Add-VerkadaAccessGroup.md rename to docs/function-documentation/Access/Add-VerkadaAccessGroup.md diff --git a/docs/function-documentation/Add-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Add-VerkadaAccessUserCard.md similarity index 100% rename from docs/function-documentation/Add-VerkadaAccessUserCard.md rename to docs/function-documentation/Access/Add-VerkadaAccessUserCard.md diff --git a/docs/function-documentation/Add-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md similarity index 100% rename from docs/function-documentation/Add-VerkadaAccessUserLicensePlate.md rename to docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md diff --git a/docs/function-documentation/Add-VerkadaAccessUserMfaCode.md b/docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md similarity index 100% rename from docs/function-documentation/Add-VerkadaAccessUserMfaCode.md rename to docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md diff --git a/docs/function-documentation/Disable-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md similarity index 100% rename from docs/function-documentation/Disable-VerkadaAccessUserCard.md rename to docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md diff --git a/docs/function-documentation/Disable-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md similarity index 100% rename from docs/function-documentation/Disable-VerkadaAccessUserLicensePlate.md rename to docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md diff --git a/docs/function-documentation/Enable-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md similarity index 100% rename from docs/function-documentation/Enable-VerkadaAccessUserCard.md rename to docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md diff --git a/docs/function-documentation/Enable-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md similarity index 100% rename from docs/function-documentation/Enable-VerkadaAccessUserLicensePlate.md rename to docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md diff --git a/docs/function-documentation/Get-VerkadaAccessEvents.md b/docs/function-documentation/Access/Get-VerkadaAccessEvents.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessEvents.md rename to docs/function-documentation/Access/Get-VerkadaAccessEvents.md diff --git a/docs/function-documentation/Get-VerkadaAccessGroup.md b/docs/function-documentation/Access/Get-VerkadaAccessGroup.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessGroup.md rename to docs/function-documentation/Access/Get-VerkadaAccessGroup.md diff --git a/docs/function-documentation/Get-VerkadaAccessUser.md b/docs/function-documentation/Access/Get-VerkadaAccessUser.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessUser.md rename to docs/function-documentation/Access/Get-VerkadaAccessUser.md diff --git a/docs/function-documentation/Get-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessUserProfilePicture.md rename to docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md diff --git a/docs/function-documentation/Read-VerkadaAccessGroups.md b/docs/function-documentation/Access/Read-VerkadaAccessGroups.md similarity index 100% rename from docs/function-documentation/Read-VerkadaAccessGroups.md rename to docs/function-documentation/Access/Read-VerkadaAccessGroups.md diff --git a/docs/function-documentation/Read-VerkadaAccessUsers.md b/docs/function-documentation/Access/Read-VerkadaAccessUsers.md similarity index 100% rename from docs/function-documentation/Read-VerkadaAccessUsers.md rename to docs/function-documentation/Access/Read-VerkadaAccessUsers.md diff --git a/docs/function-documentation/Remove-VerkadaAccessGroup.md b/docs/function-documentation/Access/Remove-VerkadaAccessGroup.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessGroup.md rename to docs/function-documentation/Access/Remove-VerkadaAccessGroup.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserBleUnlock.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserBleUnlock.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserCard.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserEntryCode.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserEntryCode.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserFromGroup.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserFromGroup.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserLicensePlate.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserMfaCode.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserMfaCode.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserProfilePicture.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md diff --git a/docs/function-documentation/Remove-VerkadaAccessUserRemoteUnlock.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaAccessUserRemoteUnlock.md rename to docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md diff --git a/docs/function-documentation/Send-VerkadaPassInvite.md b/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md similarity index 81% rename from docs/function-documentation/Send-VerkadaPassInvite.md rename to docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md index 906dfd3..fddffce 100644 --- a/docs/function-documentation/Send-VerkadaPassInvite.md +++ b/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md @@ -1,11 +1,11 @@ --- external help file: verkadaModule-help.xml Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md +online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md schema: 2.0.0 --- -# Send-VerkadaPassInvite +# Send-VerkadaAccessPassInvite ## SYNOPSIS Send a Verkada Pass email invited to an Access user in an organization using https://apidocs.verkada.com/reference/postsendpassappinviteviewv1 @@ -13,7 +13,7 @@ Send a Verkada Pass email invited to an Access user in an organization using htt ## SYNTAX ``` -Send-VerkadaPassInvite [[-userId] ] [[-externalId] ] [-activateBLE] +Send-VerkadaAccessPassInvite [[-userId] ] [[-externalId] ] [-activateBLE] [[-x_verkada_auth_api] ] [[-region] ] [-errorsToFile] [-ProgressAction ] [] ``` @@ -26,19 +26,19 @@ The reqired token can be directly submitted as a parameter, but is much easier t ### EXAMPLE 1 ``` -Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' +Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. ``` ### EXAMPLE 2 ``` -Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE +Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and activate BLE unlocks. The token will be populated from the cache created by Connect-Verkada. ``` ### EXAMPLE 3 ``` -Send-VerkadaPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' This will send an email invite to an Access user with -externalId 'newUserUPN@contoso.com'. The token is submitted as a parameter in the call. ``` @@ -160,5 +160,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md) +[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md) diff --git a/docs/function-documentation/Set-VerkadaAccessUserBleUnlock.md b/docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserBleUnlock.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserEndDate.md b/docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserEndDate.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserEntryCode.md b/docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserEntryCode.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserGroup.md b/docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserGroup.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserRemoteUnlock.md b/docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserRemoteUnlock.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserStartDate.md b/docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserStartDate.md rename to docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md diff --git a/docs/function-documentation/Unlock-VerkadaAccessDoor.md b/docs/function-documentation/Access/Unlock-VerkadaAccessDoor.md similarity index 100% rename from docs/function-documentation/Unlock-VerkadaAccessDoor.md rename to docs/function-documentation/Access/Unlock-VerkadaAccessDoor.md diff --git a/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md b/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md deleted file mode 100644 index 1d8edd4..0000000 --- a/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: verkadaModule-help.xml -Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md -schema: 2.0.0 ---- - -# Add-VerkadaLicensePlateOfInterest - -## SYNOPSIS -Creates a License Plate of Interest for an organization using a specified description and license plate number. - -## SYNTAX - -``` -Add-VerkadaLicensePlateOfInterest [-org_id ] [-license_plate] [-description] - [-x_verkada_auth_api ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function uses the public api endpoint(https://api.verkada.com/cameras/v1/analytics/lpr/license_plate_of_interest) to add a License Plate of Interest to the specified organization. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. - -## EXAMPLES - -### EXAMPLE 1 -``` -Add-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 2 -``` -Add-VerkadaLPoI 'ABC123' 'New License Plate' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 3 -``` -Import-CSV ./file_ofLicenses_and_Descriptions.csv | Add-VerkadaLPoI -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 4 -``` -Add-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -org_id 'deds343-uuid-of-org' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -The org_id and tokens are submitted as parameters in the call. -``` - -## PARAMETERS - -### -org_id -The UUID of the organization the user belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.org_id -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -license_plate -The license plate number of the License Plate of Interest - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -description -The description for the License Plate of Interest - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -x_verkada_auth_api -The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.x_verkada_auth_api -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md) - diff --git a/docs/function-documentation/Add-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md similarity index 100% rename from docs/function-documentation/Add-VerkadaCameraLicensePlateOfInterest.md rename to docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md diff --git a/docs/function-documentation/Get-VerkadaCameraCloudBackupSettings.md b/docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md similarity index 100% rename from docs/function-documentation/Get-VerkadaCameraCloudBackupSettings.md rename to docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md diff --git a/docs/function-documentation/Get-VerkadaCameras.md b/docs/function-documentation/Cameras/Get-VerkadaCameras.md similarity index 100% rename from docs/function-documentation/Get-VerkadaCameras.md rename to docs/function-documentation/Cameras/Get-VerkadaCameras.md diff --git a/docs/function-documentation/Get-VerkadaLicensePlatesOfInterest.md b/docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md similarity index 100% rename from docs/function-documentation/Get-VerkadaLicensePlatesOfInterest.md rename to docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md diff --git a/docs/function-documentation/Remove-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaCameraLicensePlateOfInterest.md rename to docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md diff --git a/docs/function-documentation/Set-VerkadaCameraCloudBackupSettings.md b/docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraCloudBackupSettings.md rename to docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md diff --git a/docs/function-documentation/Set-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraLicensePlateOfInterest.md rename to docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md diff --git a/docs/function-documentation/Connect-Verkada.md b/docs/function-documentation/Common/Connect-Verkada.md similarity index 100% rename from docs/function-documentation/Connect-Verkada.md rename to docs/function-documentation/Common/Connect-Verkada.md diff --git a/docs/function-documentation/Disconnect-Verkada.md b/docs/function-documentation/Common/Disconnect-Verkada.md similarity index 100% rename from docs/function-documentation/Disconnect-Verkada.md rename to docs/function-documentation/Common/Disconnect-Verkada.md diff --git a/docs/function-documentation/Get-Otp.md b/docs/function-documentation/Common/Get-Otp.md similarity index 100% rename from docs/function-documentation/Get-Otp.md rename to docs/function-documentation/Common/Get-Otp.md diff --git a/docs/function-documentation/Add-VerkadaCommandUser.md b/docs/function-documentation/Core/Add-VerkadaCommandUser.md similarity index 100% rename from docs/function-documentation/Add-VerkadaCommandUser.md rename to docs/function-documentation/Core/Add-VerkadaCommandUser.md diff --git a/docs/function-documentation/Get-VerkadaCommandUser.md b/docs/function-documentation/Core/Get-VerkadaCommandUser.md similarity index 94% rename from docs/function-documentation/Get-VerkadaCommandUser.md rename to docs/function-documentation/Core/Get-VerkadaCommandUser.md index f818228..cc8f5ed 100644 --- a/docs/function-documentation/Get-VerkadaCommandUser.md +++ b/docs/function-documentation/Core/Get-VerkadaCommandUser.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-VerkadaCommandUser ## SYNOPSIS -using https://apidocs.verkada.com/reference/getuserviewv1 +Gets a Command user using https://apidocs.verkada.com/reference/getuserviewv1 ## SYNTAX diff --git a/docs/function-documentation/Remove-VerkadaCommandUser.md b/docs/function-documentation/Core/Remove-VerkadaCommandUser.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaCommandUser.md rename to docs/function-documentation/Core/Remove-VerkadaCommandUser.md diff --git a/docs/function-documentation/Set-VerkadaCommandUser.md b/docs/function-documentation/Core/Set-VerkadaCommandUser.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCommandUser.md rename to docs/function-documentation/Core/Set-VerkadaCommandUser.md diff --git a/docs/function-documentation/Get-VerkadaCloudBackupSettings.md b/docs/function-documentation/Get-VerkadaCloudBackupSettings.md deleted file mode 100644 index e81635a..0000000 --- a/docs/function-documentation/Get-VerkadaCloudBackupSettings.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: verkadaModule-help.xml -Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaCloudBackupSettings.md -schema: 2.0.0 ---- - -# Get-VerkadaCloudBackupSettings - -## SYNOPSIS -Gets a camera's cloud backup settings - -## SYNTAX - -``` -Get-VerkadaCloudBackupSettings [-camera_id] [[-org_id] ] [[-x_verkada_auth_api] ] - [-region ] [-backup] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function will retrieve the cloud backup settings of the camera requested. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. - -## EXAMPLES - -### EXAMPLE 1 -``` -Get-VerkadaCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 2 -``` -Get-VerkadaCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -org_id 'deds343-uuid-of-org' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. The org_id and tokens are submitted as parameters in the call. -``` - -### EXAMPLE 3 -``` -Get-VerkadaCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -backup -This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId and write it to a csv. The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -## PARAMETERS - -### -camera_id -The UUID of the camera who's cloud backup seetings are being retrieved - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -org_id -The UUID of the organization the user belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: $Global:verkadaConnection.org_id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -x_verkada_auth_api -The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: $Global:verkadaConnection.x_verkada_auth_api -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -region -The region of the public API to be used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Api -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -backup -Switch used to write the retrieved cloud backup settings to a csv. -This will prompt for the path and file name for the output csv when the backup switch is used - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaCloudBackupSettings.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaCloudBackupSettings.md) - diff --git a/docs/function-documentation/Read-VerkadaGuestSites.md b/docs/function-documentation/Guest/Read-VerkadaGuestSites.md similarity index 100% rename from docs/function-documentation/Read-VerkadaGuestSites.md rename to docs/function-documentation/Guest/Read-VerkadaGuestSites.md diff --git a/docs/function-documentation/Add-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Add-VerkadaHelixEvent.md similarity index 100% rename from docs/function-documentation/Add-VerkadaHelixEvent.md rename to docs/function-documentation/Helix/Add-VerkadaHelixEvent.md diff --git a/docs/function-documentation/Find-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Find-VerkadaHelixEvent.md similarity index 100% rename from docs/function-documentation/Find-VerkadaHelixEvent.md rename to docs/function-documentation/Helix/Find-VerkadaHelixEvent.md diff --git a/docs/function-documentation/Get-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Get-VerkadaHelixEvent.md similarity index 100% rename from docs/function-documentation/Get-VerkadaHelixEvent.md rename to docs/function-documentation/Helix/Get-VerkadaHelixEvent.md diff --git a/docs/function-documentation/Remove-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaHelixEvent.md rename to docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md diff --git a/docs/function-documentation/Set-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Set-VerkadaHelixEvent.md similarity index 100% rename from docs/function-documentation/Set-VerkadaHelixEvent.md rename to docs/function-documentation/Helix/Set-VerkadaHelixEvent.md diff --git a/docs/function-documentation/Add-VerkadaAccessSiteAdmin.md b/docs/function-documentation/Legacy/Access/Add-VerkadaAccessSiteAdmin.md similarity index 100% rename from docs/function-documentation/Add-VerkadaAccessSiteAdmin.md rename to docs/function-documentation/Legacy/Access/Add-VerkadaAccessSiteAdmin.md diff --git a/docs/function-documentation/Get-VerkadaAccessCredential.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessCredential.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessCredential.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessCredential.md diff --git a/docs/function-documentation/Get-VerkadaAccessDoorConfigReport.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoorConfigReport.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessDoorConfigReport.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoorConfigReport.md diff --git a/docs/function-documentation/Get-VerkadaAccessDoorSchedules.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoorSchedules.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessDoorSchedules.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoorSchedules.md diff --git a/docs/function-documentation/Get-VerkadaAccessDoors.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoors.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessDoors.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessDoors.md diff --git a/docs/function-documentation/Get-VerkadaAccessLevels.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessLevels.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessLevels.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessLevels.md diff --git a/docs/function-documentation/Get-VerkadaAccessSite.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessSite.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessSite.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessSite.md diff --git a/docs/function-documentation/Get-VerkadaAccessUserReport.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessUserReport.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessUserReport.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessUserReport.md diff --git a/docs/function-documentation/Get-VerkadaAccessUserViaGraphql.md b/docs/function-documentation/Legacy/Access/Get-VerkadaAccessUserViaGraphql.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAccessUserViaGraphql.md rename to docs/function-documentation/Legacy/Access/Get-VerkadaAccessUserViaGraphql.md diff --git a/docs/function-documentation/Read-VerkadaAccessEntities.md b/docs/function-documentation/Legacy/Access/Read-VerkadaAccessEntities.md similarity index 100% rename from docs/function-documentation/Read-VerkadaAccessEntities.md rename to docs/function-documentation/Legacy/Access/Read-VerkadaAccessEntities.md diff --git a/docs/function-documentation/Read-VerkadaAccessSchedules.md b/docs/function-documentation/Legacy/Access/Read-VerkadaAccessSchedules.md similarity index 100% rename from docs/function-documentation/Read-VerkadaAccessSchedules.md rename to docs/function-documentation/Legacy/Access/Read-VerkadaAccessSchedules.md diff --git a/docs/function-documentation/Set-VerkadaAccessDoorName.md b/docs/function-documentation/Legacy/Access/Set-VerkadaAccessDoorName.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessDoorName.md rename to docs/function-documentation/Legacy/Access/Set-VerkadaAccessDoorName.md diff --git a/docs/function-documentation/Set-VerkadaAccessDoorScheduleOverride.md b/docs/function-documentation/Legacy/Access/Set-VerkadaAccessDoorScheduleOverride.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessDoorScheduleOverride.md rename to docs/function-documentation/Legacy/Access/Set-VerkadaAccessDoorScheduleOverride.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserEmail.md b/docs/function-documentation/Legacy/Access/Set-VerkadaAccessUserEmail.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserEmail.md rename to docs/function-documentation/Legacy/Access/Set-VerkadaAccessUserEmail.md diff --git a/docs/function-documentation/Set-VerkadaAccessUserEmployementDetail.md b/docs/function-documentation/Legacy/Access/Set-VerkadaAccessUserEmployementDetail.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAccessUserEmployementDetail.md rename to docs/function-documentation/Legacy/Access/Set-VerkadaAccessUserEmployementDetail.md diff --git a/docs/function-documentation/Get-VerkadaAlarmsDevices.md b/docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsDevices.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAlarmsDevices.md rename to docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsDevices.md diff --git a/docs/function-documentation/Get-VerkadaAlarmsSiteConfig.md b/docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteConfig.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAlarmsSiteConfig.md rename to docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteConfig.md diff --git a/docs/function-documentation/Get-VerkadaAlarmsSiteContacts.md b/docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteContacts.md similarity index 100% rename from docs/function-documentation/Get-VerkadaAlarmsSiteContacts.md rename to docs/function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteContacts.md diff --git a/docs/function-documentation/Read-VerkadaAlarmsSites.md b/docs/function-documentation/Legacy/Alarms/Read-VerkadaAlarmsSites.md similarity index 100% rename from docs/function-documentation/Read-VerkadaAlarmsSites.md rename to docs/function-documentation/Legacy/Alarms/Read-VerkadaAlarmsSites.md diff --git a/docs/function-documentation/Set-VerkadaAlarmsDoorSensorSettings.md b/docs/function-documentation/Legacy/Alarms/Set-VerkadaAlarmsDoorSensorSettings.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAlarmsDoorSensorSettings.md rename to docs/function-documentation/Legacy/Alarms/Set-VerkadaAlarmsDoorSensorSettings.md diff --git a/docs/function-documentation/Set-VerkadaAlarmsPanicButtonSettings.md b/docs/function-documentation/Legacy/Alarms/Set-VerkadaAlarmsPanicButtonSettings.md similarity index 100% rename from docs/function-documentation/Set-VerkadaAlarmsPanicButtonSettings.md rename to docs/function-documentation/Legacy/Alarms/Set-VerkadaAlarmsPanicButtonSettings.md diff --git a/docs/function-documentation/Add-VerkadaCamera.md b/docs/function-documentation/Legacy/Cameras/Add-VerkadaCamera.md similarity index 100% rename from docs/function-documentation/Add-VerkadaCamera.md rename to docs/function-documentation/Legacy/Cameras/Add-VerkadaCamera.md diff --git a/docs/function-documentation/Get-VerkadaCameraConfig.md b/docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md similarity index 100% rename from docs/function-documentation/Get-VerkadaCameraConfig.md rename to docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md diff --git a/docs/function-documentation/Read-VerkadaCameraArchives.md b/docs/function-documentation/Legacy/Cameras/Read-VerkadaCameraArchives.md similarity index 100% rename from docs/function-documentation/Read-VerkadaCameraArchives.md rename to docs/function-documentation/Legacy/Cameras/Read-VerkadaCameraArchives.md diff --git a/docs/function-documentation/Remove-VerkadaCameraArchive.md b/docs/function-documentation/Legacy/Cameras/Remove-VerkadaCameraArchive.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaCameraArchive.md rename to docs/function-documentation/Legacy/Cameras/Remove-VerkadaCameraArchive.md diff --git a/docs/function-documentation/Set-VerkadaCameraName.md b/docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraName.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraName.md rename to docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraName.md diff --git a/docs/function-documentation/Set-VerkadaCameraOrientation.md b/docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraOrientation.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraOrientation.md rename to docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraOrientation.md diff --git a/docs/function-documentation/Set-VerkadaCameraTamperSensitivity.md b/docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraTamperSensitivity.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraTamperSensitivity.md rename to docs/function-documentation/Legacy/Cameras/Set-VerkadaCameraTamperSensitivity.md diff --git a/docs/function-documentation/Add-VerkadaCommandSite.md b/docs/function-documentation/Legacy/Core/Add-VerkadaCommandSite.md similarity index 100% rename from docs/function-documentation/Add-VerkadaCommandSite.md rename to docs/function-documentation/Legacy/Core/Add-VerkadaCommandSite.md diff --git a/docs/function-documentation/Find-VerkadaCommandUser.md b/docs/function-documentation/Legacy/Core/Find-VerkadaCommandUser.md similarity index 100% rename from docs/function-documentation/Find-VerkadaCommandUser.md rename to docs/function-documentation/Legacy/Core/Find-VerkadaCommandUser.md diff --git a/docs/function-documentation/Find-VerkadaUserId.md b/docs/function-documentation/Legacy/Core/Find-VerkadaUserId.md similarity index 100% rename from docs/function-documentation/Find-VerkadaUserId.md rename to docs/function-documentation/Legacy/Core/Find-VerkadaUserId.md diff --git a/docs/function-documentation/Get-VerkadaCameraGroup.md b/docs/function-documentation/Legacy/Core/Get-VerkadaCameraGroup.md similarity index 100% rename from docs/function-documentation/Get-VerkadaCameraGroup.md rename to docs/function-documentation/Legacy/Core/Get-VerkadaCameraGroup.md diff --git a/docs/function-documentation/Read-VerkadaCommandUsers.md b/docs/function-documentation/Legacy/Core/Read-VerkadaCommandUsers.md similarity index 100% rename from docs/function-documentation/Read-VerkadaCommandUsers.md rename to docs/function-documentation/Legacy/Core/Read-VerkadaCommandUsers.md diff --git a/docs/function-documentation/Set-VerkadaCameraSite.md b/docs/function-documentation/Legacy/Core/Set-VerkadaCameraSite.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCameraSite.md rename to docs/function-documentation/Legacy/Core/Set-VerkadaCameraSite.md diff --git a/docs/function-documentation/Set-VerkadaCommandPermissions.md b/docs/function-documentation/Legacy/Core/Set-VerkadaCommandPermissions.md similarity index 100% rename from docs/function-documentation/Set-VerkadaCommandPermissions.md rename to docs/function-documentation/Legacy/Core/Set-VerkadaCommandPermissions.md diff --git a/docs/function-documentation/Set-VerkadaSitePermissions.md b/docs/function-documentation/Legacy/Core/Set-VerkadaSitePermissions.md similarity index 100% rename from docs/function-documentation/Set-VerkadaSitePermissions.md rename to docs/function-documentation/Legacy/Core/Set-VerkadaSitePermissions.md diff --git a/docs/function-documentation/Add-VerkadaWorkplaceEmployee.md b/docs/function-documentation/Legacy/Guest/Add-VerkadaWorkplaceEmployee.md similarity index 100% rename from docs/function-documentation/Add-VerkadaWorkplaceEmployee.md rename to docs/function-documentation/Legacy/Guest/Add-VerkadaWorkplaceEmployee.md diff --git a/docs/function-documentation/Get-VerkadaWorkplaceEmployee.md b/docs/function-documentation/Legacy/Guest/Get-VerkadaWorkplaceEmployee.md similarity index 100% rename from docs/function-documentation/Get-VerkadaWorkplaceEmployee.md rename to docs/function-documentation/Legacy/Guest/Get-VerkadaWorkplaceEmployee.md diff --git a/docs/function-documentation/Read-VerkadaWorkplaceEmployees.md b/docs/function-documentation/Legacy/Guest/Read-VerkadaWorkplaceEmployees.md similarity index 100% rename from docs/function-documentation/Read-VerkadaWorkplaceEmployees.md rename to docs/function-documentation/Legacy/Guest/Read-VerkadaWorkplaceEmployees.md diff --git a/docs/function-documentation/Remove-VerkadaWorkplaceEmployee.md b/docs/function-documentation/Legacy/Guest/Remove-VerkadaWorkplaceEmployee.md similarity index 100% rename from docs/function-documentation/Remove-VerkadaWorkplaceEmployee.md rename to docs/function-documentation/Legacy/Guest/Remove-VerkadaWorkplaceEmployee.md diff --git a/docs/function-documentation/Set-VerkadaWorkplaceEmployee.md b/docs/function-documentation/Legacy/Guest/Set-VerkadaWorkplaceEmployee.md similarity index 100% rename from docs/function-documentation/Set-VerkadaWorkplaceEmployee.md rename to docs/function-documentation/Legacy/Guest/Set-VerkadaWorkplaceEmployee.md diff --git a/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md b/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md deleted file mode 100644 index 825e346..0000000 --- a/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: verkadaModule-help.xml -Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md -schema: 2.0.0 ---- - -# Remove-VerkadaLicensePlateOfInterest - -## SYNOPSIS -Deletes a License Plate of Interest for an organization using a license plate number. - -## SYNTAX - -``` -Remove-VerkadaLicensePlateOfInterest [-org_id ] [-license_plate] - [-x_verkada_auth_api ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function uses the public api endpoint(https://api.verkada.com/cameras/v1/analytics/lpr/license_plate_of_interest) to delete a License Plate of Interest from the specified organization. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. - -## EXAMPLES - -### EXAMPLE 1 -``` -Remove-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 2 -``` -Remove-VerkadaLPoI 'ABC123' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 3 -``` -Import-CSV ./file_ofLicenses.csv | Remove-VerkadaLPoI -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 4 -``` -Remove-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -org_id 'deds343-uuid-of-org' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -The org_id and tokens are submitted as parameters in the call. -``` - -## PARAMETERS - -### -org_id -The UUID of the organization the user belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.org_id -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -license_plate -The license plate number of the License Plate of Interest - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -x_verkada_auth_api -The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.x_verkada_auth_api -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Remove-VerkadaLicensePlateOfInterest.md) - diff --git a/docs/function-documentation/Set-VerkadaCloudBackupSettings.md b/docs/function-documentation/Set-VerkadaCloudBackupSettings.md deleted file mode 100644 index 6e7fe29..0000000 --- a/docs/function-documentation/Set-VerkadaCloudBackupSettings.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: verkadaModule-help.xml -Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaCloudBackupSettings.md -schema: 2.0.0 ---- - -# Set-VerkadaCloudBackupSettings - -## SYNOPSIS -Sets a camera's cloud backup settings - -## SYNTAX - -``` -Set-VerkadaCloudBackupSettings [-camera_id] [[-org_id] ] [[-x_verkada_auth_api] ] - [-region ] -days_to_preserve -enabled -time_to_preserve - -upload_timeslot -video_quality -video_to_upload - [-ProgressAction ] [] -``` - -## DESCRIPTION -This function set the cloud back settings for a camera or cameras. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-VerkadaCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the submitted settings. The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 2 -``` -Set-VerkadaCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -org_id 'deds343-uuid-of-org' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the submitted settings. The org_id and tokens are submitted as parameters in the call. -``` - -### EXAMPLE 3 -``` -import-Csv ./cameras.csv | Set-VerkadaCloudBackupSettings -This will set the camera cloud backup settings for all the rows in the CSV which contains all needed params. The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -## PARAMETERS - -### -camera_id -The UUID of the camera who's cloud backup seetings are being changed - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -org_id -The UUID of the organization the user belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: $Global:verkadaConnection.org_id -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -x_verkada_auth_api -The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: $Global:verkadaConnection.x_verkada_auth_api -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -region -The region of the public API to be used - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Api -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -days_to_preserve -Delimited list of booleans indicating which days footage should be uploaded. -The elements in the array indicate the following days in order: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. -If value is 1, cloud backup is on for that day. -If value is 0, cloud backup is off for that day. -For example, 0,1,1,1,1,1,0 means only backup on weekdays. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -enabled -Status of cloud backup for a camera. -If value is 1, cloud backup is enabled. -If value is 0, cloud backup is disabled. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -time_to_preserve -Delimited list of start_time, end_time as timeslot for which a user wants footage to be backed up to the cloud, start_time and end_time are integers indicating seconds to midnight, i.e, 3600,7200 means 1am - 2am - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -upload_timeslot -Delimited list of start_time, end_time as timeslot for scheduled time for footage upload, start_time and end_time are integers indicating seconds to midnight, i.e, 3600,7200 means 1am - 2am - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -video_quality -Quality of the uploaded video. -Two values are possible: STANDARD_QUALITY and HIGH_QUALITY. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -video_to_upload -The type of video that is backed-up. -Two values are possible: MOTION and ALL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaCloudBackupSettings.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaCloudBackupSettings.md) - diff --git a/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md b/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md deleted file mode 100644 index 5a54a72..0000000 --- a/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: verkadaModule-help.xml -Module Name: verkadaModule -online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md -schema: 2.0.0 ---- - -# Set-VerkadaLicensePlateOfInterest - -## SYNOPSIS -Updates a License Plate of Interest for an organization using a specified description and license plate number. - -## SYNTAX - -``` -Set-VerkadaLicensePlateOfInterest [-org_id ] [-license_plate] [-description] - [-x_verkada_auth_api ] [-ProgressAction ] [] -``` - -## DESCRIPTION -This function uses the public api endpoint(https://api.verkada.com/cameras/v1/analytics/lpr/license_plate_of_interest) to update a License Plate of Interest to the specified organization. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. - -## EXAMPLES - -### EXAMPLE 1 -``` -Set-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 2 -``` -Set-VerkadaLPoI 'ABC123' 'New License Plate Descriptionv2' -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 3 -``` -Import-CSV ./file_ofLicenses_and_Descriptions.csv | Set-VerkadaLPoI -The org_id and tokens will be populated from the cached created by Connect-Verkada. -``` - -### EXAMPLE 4 -``` -Set-VerkadaLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -org_id 'deds343-uuid-of-org' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -The org_id and tokens are submitted as parameters in the call. -``` - -## PARAMETERS - -### -org_id -The UUID of the organization the user belongs to - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.org_id -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -license_plate -The license plate number of the License Plate of Interest - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -description -The description for the License Plate of Interest - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -x_verkada_auth_api -The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $Global:verkadaConnection.x_verkada_auth_api -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaLicensePlateOfInterest.md) - diff --git a/docs/reference.md b/docs/reference.md index 98d061c..5733103 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,95 +1,131 @@ # Verkada PowerShell module + ## Command Documentation -* [Add-VerkadaAccessGroup](function-documentation/Add-VerkadaAccessGroup.md) -* [Add-VerkadaAccessSiteAdmin](function-documentation/Add-VerkadaAccessSiteAdmin.md) -* [Add-VerkadaAccessUserCard](function-documentation/Add-VerkadaAccessUserCard.md) -* [Add-VerkadaAccessUserLicensePlate](function-documentation/Add-VerkadaAccessUserLicensePlate.md) -* [Add-VerkadaAccessUserMfaCode](function-documentation/Add-VerkadaAccessUserMfaCode.md) -* [Add-VerkadaCamera](function-documentation/Add-VerkadaCamera.md) -* [Add-VerkadaCameraLicensePlateOfInterest](function-documentation/Add-VerkadaCameraLicensePlateOfInterest.md) -* [Add-VerkadaCommandSite](function-documentation/Add-VerkadaCommandSite.md) -* [Add-VerkadaCommandUser](function-documentation/Add-VerkadaCommandUser.md) -* [Add-VerkadaHelixEvent](function-documentation/Add-VerkadaHelixEvent.md) -* [Add-VerkadaWorkplaceEmployee](function-documentation/Add-VerkadaWorkplaceEmployee.md) -* [Connect-Verkada](function-documentation/Connect-Verkada.md) -* [Disable-VerkadaAccessUserCard](function-documentation/Disable-VerkadaAccessUserCard.md) -* [Disable-VerkadaAccessUserLicensePlate](function-documentation/Disable-VerkadaAccessUserLicensePlate.md) -* [Disconnect-Verkada](function-documentation/Disconnect-Verkada.md) -* [Enable-VerkadaAccessUserCard](function-documentation/Enable-VerkadaAccessUserCard.md) -* [Enable-VerkadaAccessUserLicensePlate](function-documentation/Enable-VerkadaAccessUserLicensePlate.md) -* [Find-VerkadaCommandUser](function-documentation/Find-VerkadaCommandUser.md) -* [Find-VerkadaHelixEvent](function-documentation/Find-VerkadaHelixEvent.md) -* [Find-VerkadaUserId](function-documentation/Find-VerkadaUserId.md) -* [Get-Otp](function-documentation/Get-Otp.md) -* [Get-VerkadaAccessCredential](function-documentation/Get-VerkadaAccessCredential.md) -* [Get-VerkadaAccessDoorConfigReport](function-documentation/Get-VerkadaAccessDoorConfigReport.md) -* [Get-VerkadaAccessDoors](function-documentation/Get-VerkadaAccessDoors.md) -* [Get-VerkadaAccessDoorSchedules](function-documentation/Get-VerkadaAccessDoorSchedules.md) -* [Get-VerkadaAccessEvents](function-documentation/Get-VerkadaAccessEvents.md) -* [Get-VerkadaAccessGroup](function-documentation/Get-VerkadaAccessGroup.md) -* [Get-VerkadaAccessLevels](function-documentation/Get-VerkadaAccessLevels.md) -* [Get-VerkadaAccessSite](function-documentation/Get-VerkadaAccessSite.md) -* [Get-VerkadaAccessUser](function-documentation/Get-VerkadaAccessUser.md) -* [Get-VerkadaAccessUserProfilePicture](function-documentation/Get-VerkadaAccessUserProfilePicture.md) -* [Get-VerkadaAccessUserReport](function-documentation/Get-VerkadaAccessUserReport.md) -* [Get-VerkadaAccessUserViaGraphql](function-documentation/Get-VerkadaAccessUserViaGraphql.md) -* [Get-VerkadaAlarmsDevices](function-documentation/Get-VerkadaAlarmsDevices.md) -* [Get-VerkadaAlarmsSiteConfig](function-documentation/Get-VerkadaAlarmsSiteConfig.md) -* [Get-VerkadaAlarmsSiteContacts](function-documentation/Get-VerkadaAlarmsSiteContacts.md) -* [Get-VerkadaCameraCloudBackupSettings](function-documentation/Get-VerkadaCameraCloudBackupSettings.md) -* [Get-VerkadaCameraConfig](function-documentation/Get-VerkadaCameraConfig.md) -* [Get-VerkadaCameraGroup](function-documentation/Get-VerkadaCameraGroup.md) -* [Get-VerkadaCameras](function-documentation/Get-VerkadaCameras.md) -* [Get-VerkadaCommandUser](function-documentation/Get-VerkadaCommandUser.md) -* [Get-VerkadaHelixEvent](function-documentation/Get-VerkadaHelixEvent.md) -* [Get-VerkadaLicensePlatesOfInterest](function-documentation/Get-VerkadaLicensePlatesOfInterest.md) -* [Get-VerkadaWorkplaceEmployee](function-documentation/Get-VerkadaWorkplaceEmployee.md) -* [Read-VerkadaAccessEntities](function-documentation/Read-VerkadaAccessEntities.md) -* [Read-VerkadaAccessGroups](function-documentation/Read-VerkadaAccessGroups.md) -* [Read-VerkadaAccessSchedules](function-documentation/Read-VerkadaAccessSchedules.md) -* [Read-VerkadaAccessUsers](function-documentation/Read-VerkadaAccessUsers.md) -* [Read-VerkadaAlarmsSites](function-documentation/Read-VerkadaAlarmsSites.md) -* [Read-VerkadaCameraArchives](function-documentation/Read-VerkadaCameraArchives.md) -* [Read-VerkadaCommandUsers](function-documentation/Read-VerkadaCommandUsers.md) -* [Read-VerkadaGuestSites](function-documentation/Read-VerkadaGuestSites.md) -* [Read-VerkadaWorkplaceEmployees](function-documentation/Read-VerkadaWorkplaceEmployees.md) -* [Remove-VerkadaAccessGroup](function-documentation/Remove-VerkadaAccessGroup.md) -* [Remove-VerkadaAccessUserBleUnlock](function-documentation/Remove-VerkadaAccessUserBleUnlock.md) -* [Remove-VerkadaAccessUserCard](function-documentation/Remove-VerkadaAccessUserCard.md) -* [Remove-VerkadaAccessUserEntryCode](function-documentation/Remove-VerkadaAccessUserEntryCode.md) -* [Remove-VerkadaAccessUserFromGroup](function-documentation/Remove-VerkadaAccessUserFromGroup.md) -* [Remove-VerkadaAccessUserLicensePlate](function-documentation/Remove-VerkadaAccessUserLicensePlate.md) -* [Remove-VerkadaAccessUserMfaCode](function-documentation/Remove-VerkadaAccessUserMfaCode.md) -* [Remove-VerkadaAccessUserProfilePicture](function-documentation/Remove-VerkadaAccessUserProfilePicture.md) -* [Remove-VerkadaAccessUserRemoteUnlock](function-documentation/Remove-VerkadaAccessUserRemoteUnlock.md) -* [Remove-VerkadaCameraArchive](function-documentation/Remove-VerkadaCameraArchive.md) -* [Remove-VerkadaCameraLicensePlateOfInterest](function-documentation/Remove-VerkadaCameraLicensePlateOfInterest.md) -* [Remove-VerkadaCommandUser](function-documentation/Remove-VerkadaCommandUser.md) -* [Remove-VerkadaHelixEvent](function-documentation/Remove-VerkadaHelixEvent.md) -* [Remove-VerkadaWorkplaceEmployee](function-documentation/Remove-VerkadaWorkplaceEmployee.md) -* [Send-VerkadaPassInvite](function-documentation/Send-VerkadaPassInvite.md) -* [Set-VerkadaAccessDoorName](function-documentation/Set-VerkadaAccessDoorName.md) -* [Set-VerkadaAccessDoorScheduleOverride](function-documentation/Set-VerkadaAccessDoorScheduleOverride.md) -* [Set-VerkadaAccessUserBleUnlock](function-documentation/Set-VerkadaAccessUserBleUnlock.md) -* [Set-VerkadaAccessUserEmail](function-documentation/Set-VerkadaAccessUserEmail.md) -* [Set-VerkadaAccessUserEmployementDetail](function-documentation/Set-VerkadaAccessUserEmployementDetail.md) -* [Set-VerkadaAccessUserEndDate](function-documentation/Set-VerkadaAccessUserEndDate.md) -* [Set-VerkadaAccessUserEntryCode](function-documentation/Set-VerkadaAccessUserEntryCode.md) -* [Set-VerkadaAccessUserGroup](function-documentation/Set-VerkadaAccessUserGroup.md) -* [Set-VerkadaAccessUserProfilePicture](function-documentation/Set-VerkadaAccessUserProfilePicture.md) -* [Set-VerkadaAccessUserRemoteUnlock](function-documentation/Set-VerkadaAccessUserRemoteUnlock.md) -* [Set-VerkadaAccessUserStartDate](function-documentation/Set-VerkadaAccessUserStartDate.md) -* [Set-VerkadaAlarmsDoorSensorSettings](function-documentation/Set-VerkadaAlarmsDoorSensorSettings.md) -* [Set-VerkadaAlarmsPanicButtonSettings](function-documentation/Set-VerkadaAlarmsPanicButtonSettings.md) -* [Set-VerkadaCameraCloudBackupSettings](function-documentation/Set-VerkadaCameraCloudBackupSettings.md) -* [Set-VerkadaCameraLicensePlateOfInterest](function-documentation/Set-VerkadaCameraLicensePlateOfInterest.md) -* [Set-VerkadaCameraName](function-documentation/Set-VerkadaCameraName.md) -* [Set-VerkadaCameraOrientation](function-documentation/Set-VerkadaCameraOrientation.md) -* [Set-VerkadaCameraSite](function-documentation/Set-VerkadaCameraSite.md) -* [Set-VerkadaCameraTamperSensitivity](function-documentation/Set-VerkadaCameraTamperSensitivity.md) -* [Set-VerkadaCommandPermissions](function-documentation/Set-VerkadaCommandPermissions.md) -* [Set-VerkadaCommandUser](function-documentation/Set-VerkadaCommandUser.md) -* [Set-VerkadaHelixEvent](function-documentation/Set-VerkadaHelixEvent.md) -* [Set-VerkadaSitePermissions](function-documentation/Set-VerkadaSitePermissions.md) -* [Set-VerkadaWorkplaceEmployee](function-documentation/Set-VerkadaWorkplaceEmployee.md) -* [Unlock-VerkadaAccessDoor](function-documentation/Unlock-VerkadaAccessDoor.md) + +### Access + +* [Add-VerkadaAccessGroup](function-documentation/Access/Add-VerkadaAccessGroup.md) +* [Add-VerkadaAccessUserCard](function-documentation/Access/Add-VerkadaAccessUserCard.md) +* [Add-VerkadaAccessUserLicensePlate](function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md) +* [Add-VerkadaAccessUserMfaCode](function-documentation/Access/Add-VerkadaAccessUserMfaCode.md) +* [Disable-VerkadaAccessUserCard](function-documentation/Access/Disable-VerkadaAccessUserCard.md) +* [Disable-VerkadaAccessUserLicensePlate](function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md) +* [Enable-VerkadaAccessUserCard](function-documentation/Access/Enable-VerkadaAccessUserCard.md) +* [Enable-VerkadaAccessUserLicensePlate](function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md) +* [Get-VerkadaAccessEvents](function-documentation/Access/Get-VerkadaAccessEvents.md) +* [Get-VerkadaAccessGroup](function-documentation/Access/Get-VerkadaAccessGroup.md) +* [Get-VerkadaAccessUser](function-documentation/Access/Get-VerkadaAccessUser.md) +* [Get-VerkadaAccessUserProfilePicture](function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md) +* [Read-VerkadaAccessGroups](function-documentation/Access/Read-VerkadaAccessGroups.md) +* [Read-VerkadaAccessUsers](function-documentation/Access/Read-VerkadaAccessUsers.md) +* [Remove-VerkadaAccessGroup](function-documentation/Access/Remove-VerkadaAccessGroup.md) +* [Remove-VerkadaAccessUserBleUnlock](function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md) +* [Remove-VerkadaAccessUserCard](function-documentation/Access/Remove-VerkadaAccessUserCard.md) +* [Remove-VerkadaAccessUserEntryCode](function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md) +* [Remove-VerkadaAccessUserFromGroup](function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md) +* [Remove-VerkadaAccessUserLicensePlate](function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md) +* [Remove-VerkadaAccessUserMfaCode](function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md) +* [Remove-VerkadaAccessUserProfilePicture](function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md) +* [Remove-VerkadaAccessUserRemoteUnlock](function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md) +* [Send-VerkadaAccessPassInvite](function-documentation/Access/Send-VerkadaAccessPassInvite.md) +* [Set-VerkadaAccessUserBleUnlock](function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md) +* [Set-VerkadaAccessUserEndDate](function-documentation/Access/Set-VerkadaAccessUserEndDate.md) +* [Set-VerkadaAccessUserEntryCode](function-documentation/Access/Set-VerkadaAccessUserEntryCode.md) +* [Set-VerkadaAccessUserGroup](function-documentation/Access/Set-VerkadaAccessUserGroup.md) +* [Set-VerkadaAccessUserProfilePicture](function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md) +* [Set-VerkadaAccessUserRemoteUnlock](function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md) +* [Set-VerkadaAccessUserStartDate](function-documentation/Access/Set-VerkadaAccessUserStartDate.md) +* [Unlock-VerkadaAccessDoor](function-documentation/Access/Unlock-VerkadaAccessDoor.md) + +### Cameras + +* [Add-VerkadaCameraLicensePlateOfInterest](function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md) +* [Get-VerkadaCameraCloudBackupSettings](function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md) +* [Get-VerkadaCameras](function-documentation/Cameras/Get-VerkadaCameras.md) +* [Get-VerkadaLicensePlatesOfInterest](function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md) +* [Remove-VerkadaCameraLicensePlateOfInterest](function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md) +* [Set-VerkadaCameraCloudBackupSettings](function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md) +* [Set-VerkadaCameraLicensePlateOfInterest](function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md) + +### Common + +* [Connect-Verkada](function-documentation/Common/Connect-Verkada.md) +* [Disconnect-Verkada](function-documentation/Common/Disconnect-Verkada.md) +* [Get-Otp](function-documentation/Common/Get-Otp.md) + +### Core + +* [Add-VerkadaCommandUser](function-documentation/Core/Add-VerkadaCommandUser.md) +* [Get-VerkadaCommandUser](function-documentation/Core/Get-VerkadaCommandUser.md) +* [Remove-VerkadaCommandUser](function-documentation/Core/Remove-VerkadaCommandUser.md) +* [Set-VerkadaCommandUser](function-documentation/Core/Set-VerkadaCommandUser.md) + +### Guest + +* [Read-VerkadaGuestSites](function-documentation/Guest/Read-VerkadaGuestSites.md) + +### Helix + +* [Add-VerkadaHelixEvent](function-documentation/Helix/Add-VerkadaHelixEvent.md) +* [Find-VerkadaHelixEvent](function-documentation/Helix/Find-VerkadaHelixEvent.md) +* [Get-VerkadaHelixEvent](function-documentation/Helix/Get-VerkadaHelixEvent.md) +* [Remove-VerkadaHelixEvent](function-documentation/Helix/Remove-VerkadaHelixEvent.md) +* [Set-VerkadaHelixEvent](function-documentation/Helix/Set-VerkadaHelixEvent.md) + +### Legacy + +#### Legacy Access + +* [Add-VerkadaAccessSiteAdmin](function-documentation/Legacy/Access/Add-VerkadaAccessSiteAdmin.md) +* [Get-VerkadaAccessCredential](function-documentation/Legacy/Access/Get-VerkadaAccessCredential.md) +* [Get-VerkadaAccessDoorConfigReport](function-documentation/Legacy/Access/Get-VerkadaAccessDoorConfigReport.md) +* [Get-VerkadaAccessDoors](function-documentation/Legacy/Access/Get-VerkadaAccessDoors.md) +* [Get-VerkadaAccessDoorSchedules](function-documentation/Legacy/Access/Get-VerkadaAccessDoorSchedules.md) +* [Get-VerkadaAccessLevels](function-documentation/Legacy/Access/Get-VerkadaAccessLevels.md) +* [Get-VerkadaAccessSite](function-documentation/Legacy/Access/Get-VerkadaAccessSite.md) +* [Get-VerkadaAccessUserReport](function-documentation/Legacy/Access/Get-VerkadaAccessUserReport.md) +* [Get-VerkadaAccessUserViaGraphql](function-documentation/Legacy/Access/Get-VerkadaAccessUserViaGraphql.md) +* [Read-VerkadaAccessEntities](function-documentation/Legacy/Access/Read-VerkadaAccessEntities.md) +* [Read-VerkadaAccessSchedules](function-documentation/Legacy/Access/Read-VerkadaAccessSchedules.md) +* [Set-VerkadaAccessDoorName](function-documentation/Legacy/Access/Set-VerkadaAccessDoorName.md) +* [Set-VerkadaAccessDoorScheduleOverride](function-documentation/Legacy/Access/Set-VerkadaAccessDoorScheduleOverride.md) +* [Set-VerkadaAccessUserEmail](function-documentation/Legacy/Access/Set-VerkadaAccessUserEmail.md) +* [Set-VerkadaAccessUserEmployementDetail](function-documentation/Legacy/Access/Set-VerkadaAccessUserEmployementDetail.md) + +#### Legacy Alarms + +* [Get-VerkadaAlarmsDevices](function-documentation/Legacy/Alarms/Get-VerkadaAlarmsDevices.md) +* [Get-VerkadaAlarmsSiteConfig](function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteConfig.md) +* [Get-VerkadaAlarmsSiteContacts](function-documentation/Legacy/Alarms/Get-VerkadaAlarmsSiteContacts.md) +* [Read-VerkadaAlarmsSites](function-documentation/Legacy/Alarms/Read-VerkadaAlarmsSites.md) +* [Set-VerkadaAlarmsDoorSensorSettings](function-documentation/Legacy/Alarms/Set-VerkadaAlarmsDoorSensorSettings.md) +* [Set-VerkadaAlarmsPanicButtonSettings](function-documentation/Legacy/Alarms/Set-VerkadaAlarmsPanicButtonSettings.md) + +#### Legacy Cameras + +* [Add-VerkadaCamera](function-documentation/Legacy/Cameras/Add-VerkadaCamera.md) +* [Get-VerkadaCameraConfig](function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md) +* [Read-VerkadaCameraArchives](function-documentation/Legacy/Cameras/Read-VerkadaCameraArchives.md) +* [Remove-VerkadaCameraArchive](function-documentation/Legacy/Cameras/Remove-VerkadaCameraArchive.md) +* [Set-VerkadaCameraName](function-documentation/Legacy/Cameras/Set-VerkadaCameraName.md) +* [Set-VerkadaCameraOrientation](function-documentation/Legacy/Cameras/Set-VerkadaCameraOrientation.md) +* [Set-VerkadaCameraTamperSensitivity](function-documentation/Legacy/Cameras/Set-VerkadaCameraTamperSensitivity.md) + +#### Legacy Core + +* [Add-VerkadaCommandSite](function-documentation/Legacy/Core/Add-VerkadaCommandSite.md) +* [Find-VerkadaCommandUser](function-documentation/Legacy/Core/Find-VerkadaCommandUser.md) +* [Find-VerkadaUserId](function-documentation/Legacy/Core/Find-VerkadaUserId.md) +* [Get-VerkadaCameraGroup](function-documentation/Legacy/Core/Get-VerkadaCameraGroup.md) +* [Read-VerkadaCommandUsers](function-documentation/Legacy/Core/Read-VerkadaCommandUsers.md) +* [Set-VerkadaCameraSite](function-documentation/Legacy/Core/Set-VerkadaCameraSite.md) +* [Set-VerkadaCommandPermissions](function-documentation/Legacy/Core/Set-VerkadaCommandPermissions.md) +* [Set-VerkadaSitePermissions](function-documentation/Legacy/Core/Set-VerkadaSitePermissions.md) + +#### Legacy Guest + +* [Add-VerkadaWorkplaceEmployee](function-documentation/Legacy/Guest/Add-VerkadaWorkplaceEmployee.md) +* [Get-VerkadaWorkplaceEmployee](function-documentation/Legacy/Guest/Get-VerkadaWorkplaceEmployee.md) +* [Read-VerkadaWorkplaceEmployees](function-documentation/Legacy/Guest/Read-VerkadaWorkplaceEmployees.md) +* [Remove-VerkadaWorkplaceEmployee](function-documentation/Legacy/Guest/Remove-VerkadaWorkplaceEmployee.md) +* [Set-VerkadaWorkplaceEmployee](function-documentation/Legacy/Guest/Set-VerkadaWorkplaceEmployee.md) diff --git a/verkadaModule/verkadaModule.psd1 b/verkadaModule/verkadaModule.psd1 index 98442be..571608f 100644 --- a/verkadaModule/verkadaModule.psd1 +++ b/verkadaModule/verkadaModule.psd1 @@ -12,7 +12,7 @@ RootModule = 'verkadaModule.psm1' # Version number of this module. -ModuleVersion = '0.10.0' +ModuleVersion = '0.10.1' # Supported PSEditions CompatiblePSEditions = 'Desktop', 'Core'