old cred cleanup, help updates

gdbarron · gdbarron · commit c20f2f5e2142 · 2021-07-12T16:04:59.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,25 @@
+## 3.0
+- This is a big update and one that preps us for the future (in my opinion and hopefully  :smile:).  I've tried to limit the breaking changes, but there are some at the bottom of the list.  As always, any feedback is truly appreciated.
+- New functionality in `Get-ServiceNowRecord`
+  - Add `Id` property to easily retrieve a record by either number or sysid.
+  - Add `ParentId` property to easily retrieve records based on the parent number or sysid.  For example, to retrieve catalog tasks associated with a requested item execute `Get-ServiceNowRecord -ParentId RITM01234567`.
+  - Add `Description` property to retrieve records based on a table specific description field.  For many tables this field will be short_description, but will be different for others.  For example, when performing this against the 'User' table, the description field is 'Name'.
+  - Add ability to provide a known prefixed `Id` without providing `Table`, `Get-ServiceNowRecord -Id inc0010001`.  To see the list of known prefixes, execute `$ServiceNowTable.NumberPrefix` after importing the module.
+  - Add alias `gsnr`.  With the above change, a Get can be as simple as `gsnr inc0010001`.
+- Add autocomplete for `Table` parameter in `Add-ServiceNowAttachment` and `Get-ServiceNowAttachment`.
+- Add `Id` parameter to `Add-ServiceNowAttachment` and `Update-ServiceNowRecord` which accepts either number or sysid.  Just as with `Get-ServiceNowRecord` you can now provide just `Id` if it has a known prefix.
+- Add ability to `Get-ServiceNowAttachment` to get attachments either via associated record or directly from the attachments table when you want to search all attachments.
+- Add advanced filtering and sorting functionality to `Get-ServiceNowAttachment` which can be really useful when searching across the attachments table.
+- Convert access and refresh tokens in $ServiceNowSession from plain text to a credential for added security.
+- Pipeline enhancements added in many places.
+- Add Change Task and Attachments to formats.
+- `Update-ServiceNowNumber` has been deprecated and the functionality has been added to `Update-ServiceNowRecord`.  An alias has also been added so existing scripts do not break.
+- Prep for removal of all `Get-` functions except for `Get-ServiceNowRecord` and `Get-ServiceNowAttachment`.  Table specific Get functions have been deprecated.  `Get-ServiceNowRecordInterim` has been created and all table specific Get functions have been aliased so existing scripts do not break.  Please start to migrate to `Get-ServiceNowRecord` as these functions will all be deprecated in the near future.
+- As communicated in v2.0, authentication cleanup has occurred.  This involves removal of Credential/Url authentication in each function in favor of `ServiceNowSession`.  You can still authenticate with Credential/Url, but must use `New-ServiceNowSession`.  `Set-ServiceNowAuth`, `Remove-ServiceNowAuth`, and `Test-ServiceNowAuthIsSet` have been deprecated.
+- ***Breaking change:*** rename `Get-ServiceNowAttachmentDetail` to `Get-ServiceNowAttachment`.
+- ***Breaking change:*** rename `Get-ServiceNowAttachment` to `Export-ServiceNowAttachment`.
+- ***Breaking change:*** `Get-ServiceNowTable` and `Get-ServiceNowTableEntry` have been deprecated.  Use `Get-ServiceNowRecord`.
+
 ## 2.4.2
 - Fix [#141](https://github.com/Snow-Shell/servicenow-powershell/issues/141), add `UseBasicParsing` to all API calls to keep AA from failing when IE hasn't been initialized
 
diff --git a/ServiceNow/Public/Add-ServiceNowAttachment.ps1 b/ServiceNow/Public/Add-ServiceNowAttachment.ps1
@@ -51,10 +51,6 @@ Function Add-ServiceNowAttachment {
         [Alias('sys_id', 'SysId', 'number')]
         [string] $Id,
 
-        # [Parameter(ParameterSetName = 'AutomationNumber', Mandatory)]
-        # [Parameter(ParameterSetName = 'SessionNumber', Mandatory)]
-        # [string] $Number,
-
         [Parameter(Mandatory)]
         [ValidateScript( {
                 Test-Path $_
diff --git a/ServiceNow/Public/New-ServiceNowChangeRequest.ps1 b/ServiceNow/Public/New-ServiceNowChangeRequest.ps1
@@ -156,8 +156,6 @@ function New-ServiceNowChangeRequest {
             Table             = 'change_request'
             Values            = $TableEntryValues
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/Public/New-ServiceNowIncident.ps1 b/ServiceNow/Public/New-ServiceNowIncident.ps1
@@ -128,8 +128,6 @@ function New-ServiceNowIncident {
             Table             = 'incident'
             Values            = $TableEntryValues
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/Public/Remove-ServiceNowAttachment.ps1 b/ServiceNow/Public/Remove-ServiceNowAttachment.ps1
@@ -46,8 +46,6 @@ Function Remove-ServiceNowAttachment {
             Method            = 'Delete'
             UriLeaf           = "/attachment/$SysId"
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/Public/Remove-ServiceNowRecord.ps1 b/ServiceNow/Public/Remove-ServiceNowRecord.ps1
@@ -23,9 +23,8 @@ function Remove-ServiceNowRecord {
         Table             = $Table
         SysId             = $SysId
         Connection        = $Connection
-        Credential        = $Credential
-        ServiceNowUrl     = $ServiceNowURL
         ServiceNowSession = $ServiceNowSession
     }
+    
     Invoke-ServiceNowRestMethod @params
 }
diff --git a/ServiceNow/Public/Update-ServiceNowChangeRequest.ps1 b/ServiceNow/Public/Update-ServiceNowChangeRequest.ps1
@@ -35,8 +35,6 @@ function Update-ServiceNowChangeRequest {
             SysId             = $SysId
             Values            = $Values
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/Public/Update-ServiceNowIncident.ps1 b/ServiceNow/Public/Update-ServiceNowIncident.ps1
@@ -31,8 +31,6 @@ function Update-ServiceNowIncident {
             SysId             = $SysId
             Values            = $Values
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/Public/Update-ServiceNowRequestedItem.ps1 b/ServiceNow/Public/Update-ServiceNowRequestedItem.ps1
@@ -53,8 +53,6 @@ function Update-ServiceNowRequestItem {
             SysId             = $SysId
             Values            = $Values
             Connection        = $Connection
-            Credential        = $Credential
-            ServiceNowUrl     = $ServiceNowURL
             ServiceNowSession = $ServiceNowSession
         }
 
diff --git a/ServiceNow/ServiceNow.psm1 b/ServiceNow/ServiceNow.psm1
@@ -19,6 +19,7 @@ $tableArgCompleterSb = {
 @(
     'Get-ServiceNowRecord',
     'Get-ServiceNowAttachment'
+    'Add-ServiceNowAttachment'
 ) | ForEach-Object {
     Register-ArgumentCompleter -CommandName $_ -ParameterName 'Table' -ScriptBlock $tableArgCompleterSb
 }

Original file line number	Diff line number	Diff line change
`@@ -156,8 +156,6 @@ function New-ServiceNowChangeRequest {`
`156`	`156`	`Table = 'change_request'`
`157`	`157`	`Values = $TableEntryValues`
`158`	`158`	`Connection = $Connection`
`159`		`- Credential = $Credential`
`160`		`- ServiceNowUrl = $ServiceNowURL`
`161`	`159`	`ServiceNowSession = $ServiceNowSession`
`162`	`160`	`}`
`163`	`161`
Original file line number	Diff line number	Diff line change
`@@ -128,8 +128,6 @@ function New-ServiceNowIncident {`
`128`	`128`	`Table = 'incident'`
`129`	`129`	`Values = $TableEntryValues`
`130`	`130`	`Connection = $Connection`
`131`		`- Credential = $Credential`
`132`		`- ServiceNowUrl = $ServiceNowURL`
`133`	`131`	`ServiceNowSession = $ServiceNowSession`
`134`	`132`	`}`
`135`	`133`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,6 @@ Function Remove-ServiceNowAttachment {`
`46`	`46`	`Method = 'Delete'`
`47`	`47`	`UriLeaf = "/attachment/$SysId"`
`48`	`48`	`Connection = $Connection`
`49`		`- Credential = $Credential`
`50`		`- ServiceNowUrl = $ServiceNowURL`
`51`	`49`	`ServiceNowSession = $ServiceNowSession`
`52`	`50`	`}`
`53`	`51`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,8 @@ function Remove-ServiceNowRecord {`
`23`	`23`	`Table = $Table`
`24`	`24`	`SysId = $SysId`
`25`	`25`	`Connection = $Connection`
`26`		`- Credential = $Credential`
`27`		`- ServiceNowUrl = $ServiceNowURL`
`28`	`26`	`ServiceNowSession = $ServiceNowSession`
`29`	`27`	`}`
	`28`	`+`
`30`	`29`	`Invoke-ServiceNowRestMethod @params`
`31`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,6 @@ function Update-ServiceNowChangeRequest {`
`35`	`35`	`SysId = $SysId`
`36`	`36`	`Values = $Values`
`37`	`37`	`Connection = $Connection`
`38`		`- Credential = $Credential`
`39`		`- ServiceNowUrl = $ServiceNowURL`
`40`	`38`	`ServiceNowSession = $ServiceNowSession`
`41`	`39`	`}`
`42`	`40`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,6 @@ function Update-ServiceNowIncident {`
`31`	`31`	`SysId = $SysId`
`32`	`32`	`Values = $Values`
`33`	`33`	`Connection = $Connection`
`34`		`- Credential = $Credential`
`35`		`- ServiceNowUrl = $ServiceNowURL`
`36`	`34`	`ServiceNowSession = $ServiceNowSession`
`37`	`35`	`}`
`38`	`36`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,6 @@ function Update-ServiceNowRequestItem {`
`53`	`53`	`SysId = $SysId`
`54`	`54`	`Values = $Values`
`55`	`55`	`Connection = $Connection`
`56`		`- Credential = $Credential`
`57`		`- ServiceNowUrl = $ServiceNowURL`
`58`	`56`	`ServiceNowSession = $ServiceNowSession`
`59`	`57`	`}`
`60`	`58`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ $tableArgCompleterSb = {`
`19`	`19`	`@(`
`20`	`20`	`'Get-ServiceNowRecord',`
`21`	`21`	`'Get-ServiceNowAttachment'`
	`22`	`+ 'Add-ServiceNowAttachment'`
`22`	`23`	`) \| ForEach-Object {`
`23`	`24`	`Register-ArgumentCompleter -CommandName $_ -ParameterName 'Table' -ScriptBlock $tableArgCompleterSb`
`24`	`25`	`}`