Public/Set-SignRequest.ps1
|
<#
.SYNOPSIS Sets request properties #> function Set-SignRequest { [CmdletBinding(SupportsShouldProcess)] param ( # Sign request id [Parameter(Mandatory=$true)] [string] $id, # Title [Parameter(Mandatory=$false)] [string] $title, # Description [Parameter(Mandatory=$false)] [string] $description, # autoAchive [Parameter(Mandatory=$false)] [bool] $autoArchive, #Message for the archivist [Parameter(Mandatory=$false)] [string] $archiveDescription, #Request due date [Parameter(Mandatory=$false)] [datetime] $dueDate, #Ending notification period in days. How may days before due date an automatic reminder is sent to the user. Zero means "no notification will be sent" [Parameter(Mandatory=$false)] [Int32] $notificationDays, # sendMail [Parameter(Mandatory=$false)] [bool] $sendMail, # combineDocuments [Parameter(Mandatory=$false)] [bool] $combineDocuments, #Valid user proofing methods [Parameter(Mandatory=$false)] [validateSet('NONE','BASIC','STRONG','ADVANCED','AUTOGEN')] [string[]] $validProofTypes, #Proofing scope [Parameter(Mandatory=$false)] [validateSet('All','Invitees only')] $proofScope, # custom attributes for signing request [Parameter(Mandatory=$false)] [hashtable] $attributes ) begin { $api = "/request/$id" $Body = . Get-ParameterValue -Parameters $MyInvocation.MyCommand.Parameters -BoundParameters $PSBoundParameters Write-Verbose "Set-SignRequest body: $($Body | Convertto-json)" if ($Body['attributes']) { $Body['attributes'] = [array](ConvertTo-NameValues -hashtable $Body['attributes']) } if($proofScope){ $body['proofScope'] = @{'All' = 0; 'Invitees only' = 1}[$proofScope] } if($validProofTypes){ for ($j = 0; $j -lt ([array]$validProofTypes).Count ; $j++){ $body['validProofTypes'][$j] = @{'NONE' = 0;'BASIC'=1 ;'STRONG' = 2;'ADVANCED' = 3;'AUTOGEN'= 4}[([array]$validProofTypes)[$j]] } } if($dueDate) { $body['dueDate'] = [string](get-date $body['dueDate'] -Uformat "%Y-%m-%dT%H:%M:%S.000Z") } } process { if ($PSCmdlet.ShouldProcess("ShouldProcess?")) { $result = Invoke-SignApi -body $Body -api $api -method 'PUT' if ($result.request) { $result.request } } } end { } } |