PSGitHub

0.15.240

Functions/Public/Update-GitHubUser.ps1

function Update-GitHubUser {
    <#
    .Synopsis
    Updates information for the authenticated user.

    .Example
    ### Update the user's company
    Update-GitHubUser -Company Microsoft;

    .Example
    ### Update the user's location and hireable status
    Update-GitHubUser -Hireable $false -Location 'Denver, Colorado'

    .Notes
    Created by Trevor Sullivan <trevor@trevorsullivan.net>
    #>
    [CmdletBinding()]
    param (
        [string] $Name,
        [string] $Email,
        [string] $Blog,
        [string] $Company,
        [string] $Location,

        [Alias('CanHire')]
        [bool] $Hireable,

        [string] $Biography,
        # Optional base URL of the GitHub API, for example "https://ghe.mycompany.com/api/v3/" (including the trailing slash).
        # Defaults to "https://api.github.com"
        [Uri] $BaseUri = [Uri]::new('https://api.github.com'),
        [Security.SecureString] $Token = (Get-GitHubToken)
    )

    $body = @{ }
    if ($Name) {
        $body.name = $Name
    }
    if ($Email) {
        $body.email = $Email
    }
    if ($Blog) {
        $body.blog = $Blog
    }
    if ($Company) {
        $body.company = $Company
    }
    if ($Location) {
        $body.location = $Location
    }
    if ($Hireable) {
        $body.hireable = [bool]$Hireable
    }
    if ($Biography) {
        $body.biography = $Biography
    }

    Invoke-GitHubApi -Method PATCH -Uri user -Body ($body | ConvertTo-Json) -BaseUri $BaseUri -Token $Token;
}

Export-ModuleMember -Alias @(
    (New-Alias -Name Set-GitHubAuthenticatedUser -Value Update-GitHubUser -PassThru),
    (New-Alias -Name Update-GitHubAuthenticatedUser -Value Update-GitHubUser -PassThru)
)