Added delayed checkout functionality, pipeline support of returned request response,

Author: CATgwalker

ServiceNow/Public/New-ServiceNowCatalogItem.ps1

@@ -11,6 +11,9 @@
 .PARAMETER Variables
     Key/value pairs of variable names and their values
 
+.PARAMETER CheckoutImmediately
+    If provided, a second Post for cart checkout to submit_order API Endpoint will be sent
+
 .PARAMETER PassThru
     If provided, the new record will be returned
 
@@ -47,20 +50,21 @@ function New-ServiceNowCatalogItem {
         [hashtable]$InputData,
         [Parameter()][Hashtable]$Connection,
         [Parameter()][hashtable]$ServiceNowSession = $script:ServiceNowSession,
+        [Parameter()][switch]$CheckoutImmediately,
         [Parameter()][switch]$PassThru
     )
 
     begin {
+        if (-not $PSBoundParameters.ContainsKey('CheckoutImmediately')) {
+            $CheckoutImmediately = $false
+        }
         if ($CatalogItem -match '^[a-zA-Z0-9]{32}$') {
             #Verify the sys_id of the Catalog Item
-            $CatalogItemID = (Get-ServiceNowRecord -Table sc_cat_item -AsValue -ID $CatalogItem).sys_id
-<<<<<<< HEAD
+            $CatalogItemID = Get-ServiceNowRecord -Table sc_cat_item -AsValue -ID $CatalogItem -Property sys_id
             if ([string]::IsNullOrEmpty($CatalogItemID)) { throw "Unable to find catalog item by ID '$($CatalogItem)'" } else { Write-Verbose "Found $($catalogitemid) via lookup from '$($CatalogItem)'" }
-=======
->>>>>>> 426dd6771816051effc02db641c4428a78259537
         } else {
             #Lookup the sys_id of the Catalog Item
-            $CatalogItemID = (Get-ServiceNowRecord -Table sc_cat_item -AsValue -Filter @('name', '-eq', $CatalogItem )).sys_id
+            $CatalogItemID = Get-ServiceNowRecord -Table sc_cat_item -AsValue -Filter @('name', '-eq', $CatalogItem ) -Property sys_id
             if ([string]::IsNullOrEmpty($CatalogItemID)) { throw "Unable to find catalog item by name '$($CatalogItem)'" } else { Write-Verbose "Found $($catalogitemid) via lookup from '$($CatalogItem)'" }
         }
     }
@@ -79,7 +83,7 @@ function New-ServiceNowCatalogItem {
 
             $AddItemCartResponse = Invoke-ServiceNowRestMethod @AddItemToCart
 
-            if ($AddItemCartResponse.cart_id) {
+            if ($AddItemCartResponse.cart_id -and $CheckoutImmediately) {
                 $SubmitOrder = @{
                     Method            = 'Post'
                     UriLeaf           = "/servicecatalog/cart/submit_order"
@@ -89,10 +93,13 @@ function New-ServiceNowCatalogItem {
                 }
 
                 $SubmitOrderResponse = Invoke-ServiceNowRestMethod @SubmitOrder
+
+                if ($PassThru) {
+                    $SubmitOrderResponse | Select-Object @{'n' = 'number'; 'e' = { $_.request_number } }, request_id
+                }
             }
-            if ( $PassThru ) {
-                $SubmitOrderResponse
-            }
+        } else {
+            $AddItemToCart | Out-String
         }
     }
-}
+}

ServiceNow/Public/Submit-ServiceNowCatalogOrder.ps1

@@ -0,0 +1,63 @@
+<#
+.SYNOPSIS
+    Submit a catalog request using Service Catalog API
+
+.DESCRIPTION
+    Checks out the user cart, based on the current check-out type (one-step or two-step). Reference: https://developer.servicenow.com/dev.do#!/reference/api/zurich/rest/c_ServiceCatalogAPI#servicecat-POST-cart-sub_order?navFilter=serv
+
+.PARAMETER PassThru
+    If provided, the new record will be returned
+
+.PARAMETER Connection
+    Azure Automation Connection object containing username, password, and URL for the ServiceNow instance
+
+.PARAMETER ServiceNowSession
+    ServiceNow session created by New-ServiceNowSession.  Will default to script-level variable $ServiceNowSession.
+
+.EXAMPLE
+    Submit-ServiceNowCatalogOrder
+
+    Checks out the user cart, based on the current check-out type (one-step or two-step).
+
+.EXAMPLE
+    Submit-ServiceNowCatalogOrder -PassThru
+
+    Checks out the user cart, based on the current check-out type (one-step or two-step) and returns the request numbers as an object.
+
+.INPUTS
+    InputData
+
+.OUTPUTS
+    PSCustomObject if PassThru provided
+#>
+function Submit-ServiceNowCatalogOrder {
+    [CmdletBinding(SupportsShouldProcess)]
+    param
+    (
+        [Parameter()][Hashtable]$Connection,
+        [Parameter()][hashtable]$ServiceNowSession = $script:ServiceNowSession,
+        [Parameter()][switch]$PassThru
+    )
+
+    process {
+
+        if ( $PSCmdlet.ShouldProcess('POST cart to Submit_Order API') ) {
+            $SubmitOrder = @{
+                Method            = 'Post'
+                UriLeaf           = "/servicecatalog/cart/submit_order"
+                Namespace         = 'sn_sc'
+                Connection        = $Connection
+                ServiceNowSession = $ServiceNowSession
+            }
+
+            $SubmitOrderResponse = Invoke-ServiceNowRestMethod @SubmitOrder
+
+            if ($PassThru) {
+                $SubmitOrderResponse | Select-Object @{'n' = 'number'; 'e' = { $_.request_number } }, request_id
+            }
+
+        } else {
+            Write-Output "Checks out the user cart, based on the current check-out type (one-step or two-step).`n`nIf one-step checkout, the method checks out (saves) the cart and returns the request number and the request order ID. If two-step checkout, the method returns the cart order status and all the information required for two-step checkout."
+        }
+    }
+}