Functions/Public/Set-BricksetSetUserNotes.psm1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
function Set-BricksetSetUserNotes {
<#
    .SYNOPSIS
    Set the User Notes for a Brickset Set.
    
    .DESCRIPTION
    Set the User Notes for a Brickset Set.

    .PARAMETER SetId
    Brickset SetId

    .PARAMETER Notes
    200 chars of text to add to the User Notes field of a Set

    .INPUTS
    System.String

    .OUTPUTS
    None

    .EXAMPLE
    Set-BricksetSetUserNotes -SetId 26049 -UserNotes "This is one of my favourites"

    .EXAMPLE
    Get-BricksetSet -SetNumber '7199-1' | Set-BricksetSetUserNotes -Notes "This is one of my favourites" -Confirm:$false
#>

[CmdletBinding(SupportsShouldProcess,ConfirmImpact="High")]

    Param
    (
    [parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)]
    [ValidateNotNullOrEmpty()]
    [String]$SetId,

    [parameter(Mandatory=$true)]
    [ValidateNotNullOrEmpty()]
    [String]$Notes

    )
    
    try {

        # --- Check for the presence of $Global:BricksetConnection
        xCheckGlobalBricksetConnection

        # --- Check for the UserHash
        xCheckUserHash

        # --- Make the Webservice Call
        if ($PSCmdlet.ShouldProcess($SetId)){

            $BricksetConnection.WebService.setCollection_userNotes($BricksetConnection.APIKey, $BricksetConnection.UserHash, $SetId, $Notes)
        }
    }
    catch [Exception]{
            
        throw
    }
}