diff --git a/PSGSuite/Public/Authentication/Clear-PSGSuiteServiceCache.ps1 b/PSGSuite/Public/Authentication/Clear-PSGSuiteServiceCache.ps1 index 5d2169b9..8cd583f1 100644 --- a/PSGSuite/Public/Authentication/Clear-PSGSuiteServiceCache.ps1 +++ b/PSGSuite/Public/Authentication/Clear-PSGSuiteServiceCache.ps1 @@ -8,6 +8,9 @@ function Clear-PSGSuiteServiceCache { .EXAMPLE Clear-PSGSuiteServiceCache + + .LINK + https://psgsuite.io/Function%20Help/Authentication/Clear-PSGSuiteServiceCache/ #> [CmdletBinding()] Param () diff --git a/PSGSuite/Public/Authentication/Get-GSToken.ps1 b/PSGSuite/Public/Authentication/Get-GSToken.ps1 index e22ad5cf..7487ecf8 100644 --- a/PSGSuite/Public/Authentication/Get-GSToken.ps1 +++ b/PSGSuite/Public/Authentication/Get-GSToken.ps1 @@ -18,6 +18,9 @@ function Get-GSToken { Authorization = "Bearer $($Token)" 'GData-Version' = '3.0' } + + .LINK + https://psgsuite.io/Function%20Help/Authentication/Get-GSToken/ #> Param ( [parameter(Mandatory = $true)] diff --git a/PSGSuite/Public/Authentication/Get-PSGSuiteServiceCache.ps1 b/PSGSuite/Public/Authentication/Get-PSGSuiteServiceCache.ps1 index 3b464bdf..0148b30b 100644 --- a/PSGSuite/Public/Authentication/Get-PSGSuiteServiceCache.ps1 +++ b/PSGSuite/Public/Authentication/Get-PSGSuiteServiceCache.ps1 @@ -17,6 +17,9 @@ function Get-PSGSuiteServiceCache { .EXAMPLE Get-PSGSuiteServiceCache + + .LINK + https://psgsuite.io/Function%20Help/Authentication/Get-PSGSuiteServiceCache/ #> [CmdletBinding()] Param ( diff --git a/PSGSuite/Public/Authentication/New-GoogleService.ps1 b/PSGSuite/Public/Authentication/New-GoogleService.ps1 index ad3f30d4..7352d8cf 100644 --- a/PSGSuite/Public/Authentication/New-GoogleService.ps1 +++ b/PSGSuite/Public/Authentication/New-GoogleService.ps1 @@ -21,6 +21,9 @@ function New-GoogleService { ServiceType = 'Google.Apis.Admin.Reports.reports_v1.ReportsService' } $service = New-GoogleService @serviceParams + + .LINK + https://psgsuite.io/Function%20Help/Authentication/New-GoogleService/ #> [CmdletBinding()] Param( diff --git a/PSGSuite/Public/Calendar/Add-GSCalendarSubscription.ps1 b/PSGSuite/Public/Calendar/Add-GSCalendarSubscription.ps1 index 0066c523..2fe1e461 100644 --- a/PSGSuite/Public/Calendar/Add-GSCalendarSubscription.ps1 +++ b/PSGSuite/Public/Calendar/Add-GSCalendarSubscription.ps1 @@ -71,6 +71,12 @@ function Add-GSCalendarSubscription { Add-GSCalendarSubscription -User me -CalendarId john.smith@domain.com -Selected -Color Cyan Adds the calendar 'john.smith@domain.com' to the AdminEmail user's calendar list + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Add-GSCalendarSubscription/ + + .LINK + https://developers.google.com/calendar/v3/reference/calendarList/insert #> [OutputType('Google.Apis.Calendar.v3.Data.CalendarListEntry')] [cmdletbinding()] diff --git a/PSGSuite/Public/Calendar/Get-GSCalendar.ps1 b/PSGSuite/Public/Calendar/Get-GSCalendar.ps1 index 4bea7063..c651e136 100644 --- a/PSGSuite/Public/Calendar/Get-GSCalendar.ps1 +++ b/PSGSuite/Public/Calendar/Get-GSCalendar.ps1 @@ -44,6 +44,15 @@ function Get-GSCalendar { Get-GSCalendar Gets the list of calendar subscriptions for the AdminEmail user. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Get-GSCalendar/ + + .LINK + https://developers.google.com/calendar/v3/reference/calendarList/get + + .LINK + https://developers.google.com/calendar/v3/reference/calendarList/list #> [OutputType('Google.Apis.Calendar.v3.Data.CalendarListEntry')] [cmdletbinding(DefaultParameterSetName = "List")] @@ -97,7 +106,7 @@ function Get-GSCalendar { Get { foreach ($calId in $CalendarId) { try { - $request = $service.CalendarList.Get($calId) + $request = $service.Calendars.Get($calId) Write-Verbose "Getting Calendar Id '$calId' for User '$U'" $request.Execute() | Add-Member -MemberType NoteProperty -Name 'User' -Value $U -PassThru } @@ -113,7 +122,7 @@ function Get-GSCalendar { } List { try { - $request = $service.CalendarList.List() + $request = $service.Calendars.List() foreach ($key in $PSBoundParameters.Keys | Where-Object {$_ -ne 'CalendarId'}) { if ($request.PSObject.Properties.Name -contains $key) { $request.$key = $PSBoundParameters[$key] @@ -124,7 +133,7 @@ function Get-GSCalendar { $PageSize = $Limit } $request.MaxResults = $PageSize - Write-Verbose "Getting Calendar List for user '$U'" + Write-Verbose "Getting Calendars for user '$U'" [int]$i = 1 $overLimit = $false do { diff --git a/PSGSuite/Public/Calendar/Get-GSCalendarACL.ps1 b/PSGSuite/Public/Calendar/Get-GSCalendarACL.ps1 index 558cd693..784d05e0 100644 --- a/PSGSuite/Public/Calendar/Get-GSCalendarACL.ps1 +++ b/PSGSuite/Public/Calendar/Get-GSCalendarACL.ps1 @@ -29,6 +29,15 @@ function Get-GSCalendarAcl { Get-GSCalendarACL -User me -CalendarID "primary" This gets the ACL on the primary calendar of the AdminUser. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Get-GSCalendarACL/ + + .LINK + https://developers.google.com/calendar/v3/reference/acl/get + + .LINK + https://developers.google.com/calendar/v3/reference/acl/list #> [OutputType('Google.Apis.Calendar.v3.Data.AclRule')] [cmdletbinding(DefaultParameterSetName = 'List')] diff --git a/PSGSuite/Public/Calendar/Get-GSCalendarEvent.ps1 b/PSGSuite/Public/Calendar/Get-GSCalendarEvent.ps1 index 06666859..8b4983dc 100644 --- a/PSGSuite/Public/Calendar/Get-GSCalendarEvent.ps1 +++ b/PSGSuite/Public/Calendar/Get-GSCalendarEvent.ps1 @@ -63,6 +63,15 @@ function Get-GSCalendarEvent { Get-GSCalendarEventList -TimeMin (Get-Date "01-21-2018 00:00:00") -TimeMax (Get-Date "01-28-2018 23:59:59") -SingleEvents This gets the single events on the primary calendar of the Admin for the week of Jan 21-28, 2018. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Get-GSCalendarEvent/ + + .LINK + https://developers.google.com/calendar/v3/reference/events/get + + .LINK + https://developers.google.com/calendar/v3/reference/events/list #> [OutputType('Google.Apis.Calendar.v3.Data.Event')] [cmdletbinding(DefaultParameterSetName = "List")] diff --git a/PSGSuite/Public/Calendar/Get-GSCalendarSubscription.ps1 b/PSGSuite/Public/Calendar/Get-GSCalendarSubscription.ps1 index fb0caaea..051e3eee 100644 --- a/PSGSuite/Public/Calendar/Get-GSCalendarSubscription.ps1 +++ b/PSGSuite/Public/Calendar/Get-GSCalendarSubscription.ps1 @@ -24,6 +24,9 @@ function Get-GSCalendarSubscription { Get-GSCalendarSubscription Gets the AdminEmail user's calendar list + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Get-GSCalendarSubscription/ #> [OutputType('Google.Apis.Calendar.v3.Data.CalendarListEntry')] [cmdletbinding()] diff --git a/PSGSuite/Public/Calendar/New-GSCalendarACL.ps1 b/PSGSuite/Public/Calendar/New-GSCalendarACL.ps1 index f4bfc9ef..ebfe72ea 100644 --- a/PSGSuite/Public/Calendar/New-GSCalendarACL.ps1 +++ b/PSGSuite/Public/Calendar/New-GSCalendarACL.ps1 @@ -44,6 +44,9 @@ function New-GSCalendarAcl { New-GSCalendarACL -CalendarID jennyappleseed@domain.com -Role reader -Value Jonnyappleseed@domain.com -Type user Gives Jonnyappleseed@domain.com reader access to jennyappleseed's calendar. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/New-GSCalendarACL/ #> [OutputType('Google.Apis.Calendar.v3.Data.AclRule')] [cmdletbinding(DefaultParameterSetName = "AttendeeEmails")] diff --git a/PSGSuite/Public/Calendar/New-GSCalendarEvent.ps1 b/PSGSuite/Public/Calendar/New-GSCalendarEvent.ps1 index f470612b..26b588a0 100644 --- a/PSGSuite/Public/Calendar/New-GSCalendarEvent.ps1 +++ b/PSGSuite/Public/Calendar/New-GSCalendarEvent.ps1 @@ -101,6 +101,9 @@ function New-GSCalendarEvent { New-GSCalendarEvent "Go to the gym" -StartDate (Get-Date "21:00:00") -EndDate (Get-Date "22:00:00") Creates an event titled "Go to the gym" for 9-10PM the day the function is ran. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/New-GSCalendarEvent/ #> [OutputType('Google.Apis.Calendar.v3.Data.Event')] [cmdletbinding(DefaultParameterSetName = "AttendeeEmails")] diff --git a/PSGSuite/Public/Calendar/Remove-GSCalendarAcl.ps1 b/PSGSuite/Public/Calendar/Remove-GSCalendarAcl.ps1 index 07aed25a..127ec306 100644 --- a/PSGSuite/Public/Calendar/Remove-GSCalendarAcl.ps1 +++ b/PSGSuite/Public/Calendar/Remove-GSCalendarAcl.ps1 @@ -17,11 +17,14 @@ function Remove-GSCalendarAcl { .EXAMPLE Get-GSCalendar -User joe@domain.com | - Get-GSCalendarACL | + Get-GSCalendarAcl | Where-Object {$_.Role -eq 'Owner'} | - Remove-GSCalendarACL + Remove-GSCalendarAcl Gets all the calendars for Joe and finds all ACL rules where + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Remove-GSCalendarAcl/ #> [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High")] Param diff --git a/PSGSuite/Public/Calendar/Remove-GSCalendarEvent.ps1 b/PSGSuite/Public/Calendar/Remove-GSCalendarEvent.ps1 index 22aed03e..cf136780 100644 --- a/PSGSuite/Public/Calendar/Remove-GSCalendarEvent.ps1 +++ b/PSGSuite/Public/Calendar/Remove-GSCalendarEvent.ps1 @@ -23,6 +23,9 @@ function Remove-GSCalendarEvent { Remove-GSCalendarEvent -User user@domain.com -EventID _60q30c1g60o30e1i60o4ac1g60rj8gpl88rj2c1h84s34h9g60s30c1g60o30c1g84o3eg9n8gq32d246gq48d1g64o30c1g60o30c1g60o30c1g60o32c1g60o30c1g8csjihhi6oq3igi28h248ghk6ks4agq161144ga46gr4aci488p0 Removes the specified event from user@domain.com's calendar. + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Remove-GSCalendarEvent/ #> [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "High")] Param diff --git a/PSGSuite/Public/Calendar/Remove-GSCalendarSubscription.ps1 b/PSGSuite/Public/Calendar/Remove-GSCalendarSubscription.ps1 index c60765f4..eab42842 100644 --- a/PSGSuite/Public/Calendar/Remove-GSCalendarSubscription.ps1 +++ b/PSGSuite/Public/Calendar/Remove-GSCalendarSubscription.ps1 @@ -2,20 +2,23 @@ function Remove-GSCalendarSubscription { <# .SYNOPSIS Removes a calendar from a users calendar list (aka unsubscribes from the specified calendar) - + .DESCRIPTION Removes a calendar from a users calendar list (aka unsubscribes from the specified calendar) - + .PARAMETER User The primary email or UserID of the user. You can exclude the '@domain.com' to insert the Domain in the config or use the special 'me' to indicate the AdminEmail in the config. - + .PARAMETER CalendarID The calendar ID of the calendar you would like to unsubscribe the user from - + .EXAMPLE Remove-GSCalendarSubscription -User me -CalendarId john.smith@domain.com Removes the calendar 'john.smith@domain.com' from the AdminEmail user's calendar list + + .LINK + https://psgsuite.io/Function%20Help/Calendar/Remove-GSCalendarSubscription/ #> [cmdletbinding(SupportsShouldProcess = $true,ConfirmImpact = "High")] Param @@ -63,4 +66,4 @@ function Remove-GSCalendarSubscription { } } } -} \ No newline at end of file +} diff --git a/PSGSuite/Public/RoleAssignments/Get-GSAdminRoleAssignment.ps1 b/PSGSuite/Public/Role Assignments/Get-GSAdminRoleAssignment.ps1 similarity index 100% rename from PSGSuite/Public/RoleAssignments/Get-GSAdminRoleAssignment.ps1 rename to PSGSuite/Public/Role Assignments/Get-GSAdminRoleAssignment.ps1 diff --git a/PSGSuite/Public/RoleAssignments/New-GSAdminRoleAssignment.ps1 b/PSGSuite/Public/Role Assignments/New-GSAdminRoleAssignment.ps1 similarity index 100% rename from PSGSuite/Public/RoleAssignments/New-GSAdminRoleAssignment.ps1 rename to PSGSuite/Public/Role Assignments/New-GSAdminRoleAssignment.ps1 diff --git a/PSGSuite/Public/RoleAssignments/Remove-GSAdminRoleAssignment.ps1 b/PSGSuite/Public/Role Assignments/Remove-GSAdminRoleAssignment.ps1 similarity index 100% rename from PSGSuite/Public/RoleAssignments/Remove-GSAdminRoleAssignment.ps1 rename to PSGSuite/Public/Role Assignments/Remove-GSAdminRoleAssignment.ps1 diff --git a/docs/Initial Setup.md b/docs/Initial Setup.md index e4e2a787..3ca7c6eb 100644 --- a/docs/Initial Setup.md +++ b/docs/Initial Setup.md @@ -1,20 +1,6 @@ # Initial Setup -* [Initial Setup](#initial-setup) - * [Prerequisites](#prerequisites) - * [Installing the Module](#installing-the-module) - * [From the PowerShell Gallery](#from-the-powershell-gallery) - * [From the GitHub release page](#from-the-github-release-page) - * [Build from the GitHub repo](#build-from-the-github-repo) - * [G Suite Users _with_ SuperAdmin access](#g-suite-users-with-superadmin-access) - * [Creating the Project, Service Account and P12 Key in Google's Developer Console](#creating-the-project-service-account-and-p12-key-in-googles-developer-console) - * [Adding API Client Access in Admin Console](#adding-api-client-access-in-admin-console) - * [Free Google Account Users and G Suite Users _without_ SuperAdmin access](#free-google-account-users-and-g-suite-users-without-superadmin-access) - * [Creating the Project and Client ID/Secret in Google's Developer Console](#creating-the-project-and-client-idsecret-in-googles-developer-console) - * [Creating the PSGSuite Configuration File](#creating-the-psgsuite-configuration-file) - * [First-time authentication for free/non-admin accounts](#first-time-authentication-for-freenon-admin-accounts) - -*** +Getting started with PSGSuite. ## Prerequisites In order to use this module, you will need the following: diff --git a/docs/Managing Users.md b/docs/Managing Users.md index 57921b69..b46b50fa 100644 --- a/docs/Managing Users.md +++ b/docs/Managing Users.md @@ -2,50 +2,6 @@ This section goes into detail on how to manage users, licenses and custom schemas using this module. -* [Managing Users](#managing-users) -* [User Management](#user-management) - * [Getting User Info](#getting-user-info) - * [Get-GSUser](#get-gsuser) - * [Getting User Photos](#getting-user-photos) - * [Get-GSUserPhoto](#get-gsuserphoto) - * [Listing Users](#listing-users) - * [Get-GSUserList](#get-gsuserlist) - * [Creating Users](#creating-users) - * [New-GSUser](#new-gsuser) - * [Updating Users](#updating-users) - * [Update-GSUser](#update-gsuser) - * [Removing Users](#removing-users) - * [Remove-GSUser](#remove-gsuser) - * [Restoring Users](#restoring-users) - * [Restore-GSUser](#restore-gsuser) -* [License Management](#license-management) - * [Getting License Info](#getting-license-info) - * [Get-GSLicenseInfo](#get-gslicenseinfo) - * [Listing Licenses](#listing-licenses) - * [Get-GSLicenseList](#get-gslicenselist) - * [Removing Licenses](#removing-licenses) - * [Remove-GSLicense](#remove-gslicense) - * [Setting Licenses](#setting-licenses) - * [Set-GSLicense](#set-gslicense) - * [Updating Licenses](#updating-licenses) - * [Update-GSLicense](#update-gslicense) -* [Custom Schema Management](#custom-schema-management) - * [Getting Custom Schema Info](#getting-custom-schema-info) - * [Get-GSUserSchemaInfo](#get-gsuserschemainfo) - * [Listing Custom Schemas](#listing-custom-schemas) - * [Get-GSUserSchemaList](#get-gsuserschemalist) - * [Creating Custom Schemas](#creating-custom-schemas) - * [New-GSUserSchema](#new-gsuserschema) - * [Removing Custom Schemas](#removing-custom-schemas) - * [Remove-GSUserSchema](#remove-gsuserschema) - * [Updating Custom Schemas](#updating-custom-schemas) - * [Update-GSUserSchema](#update-gsuserschema) - -*** - - -# User Management - ## Getting User Info ### Get-GSUser _This function pulls info for a specific user, including orgUnitPath, aliases, custom schema values, etc._ diff --git a/docs/index.md b/docs/index.md index fa87448e..78a206ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +title: Home +--- + # PSGSuite
PSGSuite 2.0.0 released! @@ -181,4 +185,3 @@ All other functions are either intact or have an alias included to support backw * Updated Google .NET SDKs to latest versions. * Updated and corrected a LOT of comment based function help. * Added function help tests to validate that functions contain expected help content. - diff --git a/mkdocs.yml b/mkdocs.yml index 20dac52a..ca7708b7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,7 +16,7 @@ theme: name: 'material' language: 'en' logo: - icon: 'cloud' + icon: 'arrow_forward_ios' palette: primary: 'indigo' accent: 'indigo' @@ -39,9 +39,9 @@ extra: link: 'https://linkedin.com/in/scrthq' # Google Analytics -#google_analytics: -# - 'UA-XXXXXXXX-X' -# - 'auto' +google_analytics: + - 'UA-101420411-4' + - 'auto' # Extensions markdown_extensions: diff --git a/psake.ps1 b/psake.ps1 index 49d5e1a9..bd1cb7ef 100644 --- a/psake.ps1 +++ b/psake.ps1 @@ -259,11 +259,6 @@ Task Docs -Depends Init { $funcPath = Join-Path $docPath 'Function Help' $docStage = Join-Path $PSScriptRoot 'docstage' $sitePath = Join-Path $PSScriptRoot 'site' - <# " Importing module from path: $outputModDir" - $origPSModulePath = $env:PSModulePath - $env:PSModulePath = $env:BHBuildOutput + [System.IO.Path]::PathSeparator + $env:PSModulePath - #Import-Module $outputModDir -Force -Verbose - Import-Module $env:BHProjectName -Force -Verbose #> " Setting index.md content from README" Get-Content (Join-Path $PSScriptRoot 'README.md') -Raw | Set-Content (Join-Path $docPath 'index.md') -Force