.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::GitHub::V3::Users 3pm"
.TH Net::GitHub::V3::Users 3pm "2018-04-07" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::GitHub::V3::Users \- GitHub Users API
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::GitHub::V3;
\&
\&    my $gh = Net::GitHub::V3\->new; # read L<Net::GitHub::V3> to set right authentication info
\&    my $user = $gh\->user;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
\fIUsers\fR
.IX Subsection "Users"
.PP
<http://developer.github.com/v3/users/>
.IP "show" 4
.IX Item "show"
.Vb 2
\&    my $uinfo = $user\->show(); # /user
\&    my $uinfo = $user\->show( \*(Aqnothingmuch\*(Aq ); # /users/:user
.Ve
.IP "update" 4
.IX Item "update"
.Vb 3
\&    $user\->update(
\&        bio  => \*(Aqanother Perl programmer and Father\*(Aq,
\&    );
.Ve
.PP
\fIEmails\fR
.IX Subsection "Emails"
.PP
<http://developer.github.com/v3/users/emails/>
.IP "emails" 4
.IX Item "emails"
.PD 0
.IP "add_email" 4
.IX Item "add_email"
.IP "remove_email" 4
.IX Item "remove_email"
.PD
.Vb 6
\&    $user\->add_email( \*(Aqanother@email.com\*(Aq );
\&    $user\->add_email( \*(Aqbatch1@email.com\*(Aq, \*(Aqbatch2@email.com\*(Aq );
\&    my $emails = $user\->emails;
\&    while ($email = $user\->next_email) { ...; }
\&    $user\->remove_email( \*(Aqanother@email.com\*(Aq );
\&    $user\->remove_email( \*(Aqbatch1@email.com\*(Aq, \*(Aqbatch2@email.com\*(Aq );
.Ve
.PP
\fIFollowers\fR
.IX Subsection "Followers"
.PP
<http://developer.github.com/v3/users/followers/>
.IP "followers" 4
.IX Item "followers"
.PD 0
.IP "following" 4
.IX Item "following"
.IP "next_follower" 4
.IX Item "next_follower"
.IP "next_following" 4
.IX Item "next_following"
.PD
.Vb 8
\&    my $followers = $user\->followers;
\&    my $followers = $user\->followers($user);
\&    my $following = $user\->following;
\&    my $following = $user\->following($user);
\&    my $next_follower = $user\->next_follower
\&    my $next_follower = $user\->next_follower($user)
\&    my $next_following = $user\->next_following
\&    my $next_following = $user\->next_following($user)
.Ve
.IP "is_following" 4
.IX Item "is_following"
.Vb 1
\&    my $is_following = $user\->is_following($user);
.Ve
.IP "follow" 4
.IX Item "follow"
.PD 0
.IP "unfollow" 4
.IX Item "unfollow"
.PD
.Vb 2
\&    $user\->follow( \*(Aqnothingmuch\*(Aq );
\&    $user\->unfollow( \*(Aqnothingmuch\*(Aq );
.Ve
.PP
\fIKeys\fR
.IX Subsection "Keys"
.PP
<http://developer.github.com/v3/users/keys/>
.IP "keys" 4
.IX Item "keys"
.PD 0
.IP "key" 4
.IX Item "key"
.IP "create_key" 4
.IX Item "create_key"
.IP "update_key" 4
.IX Item "update_key"
.IP "delete_key" 4
.IX Item "delete_key"
.PD
.Vb 12
\&    my $keys = $user\->keys;
\&    while (my $key = $user\->next_key) { ...; }
\&    my $key  = $user\->key($key_id); # get key
\&    $user\->create_key({
\&        title => \*(Aqtitle\*(Aq,
\&        key   => $key
\&    });
\&    $user\->update_key($key_id, {
\&        title => $title,
\&        key   => $key
\&    });
\&    $user\->delete_key($key_id);
.Ve
.IP "contributions" 4
.IX Item "contributions"
.Vb 2
\&    my $contributions = $user\->contributions($username);
\&    # $contributions = ( ..., [\*(Aq2013/09/22\*(Aq, 3], [ \*(Aq2013/09/23\*(Aq, 2 ] )
.Ve
.Sp
Unpublished GitHub \s-1API\s0 used to build the 'Public contributions' graph on a
users' profile page.  The data structure is a list of 365 arrayrefs, one per day.
Each array has two elements, the date in \s-1YYYY/MM/DD\s0 format is the first element,
the second is the number of contrubtions for that day.stree .
.SH "AUTHOR & COPYRIGHT & LICENSE"
.IX Header "AUTHOR & COPYRIGHT & LICENSE"
Refer Net::GitHub