.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pithub::Events 3pm"
.TH Pithub::Events 3pm "2014-05-18" "perl v5.18.2" "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"
Pithub::Events \- Github v3 Events API
.SH "VERSION"
.IX Header "VERSION"
version 0.01025
.SH "METHODS"
.IX Header "METHODS"
.SS "issue"
.IX Subsection "issue"
.IP "\(bu" 4
List issue events for a repository
.Sp
.Vb 1
\&    GET /repos/:user/:repo/issues/events
.Ve
.Sp
Examples:
.Sp
.Vb 5
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->issue(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&    );
.Ve
.SS "network"
.IX Subsection "network"
.IP "\(bu" 4
List public events for a network of repositories
.Sp
.Vb 1
\&    GET /networks/:user/:repo/events
.Ve
.Sp
Examples:
.Sp
.Vb 5
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->network(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&    );
.Ve
.SS "org"
.IX Subsection "org"
.IP "\(bu" 4
List public events for an organization
.Sp
.Vb 1
\&    GET /orgs/:org/events
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $e = Pithub::Events\->new;
\&    my $result = $e\->org( org => \*(AqCPAN\-API\*(Aq );
.Ve
.SS "org_for_user"
.IX Subsection "org_for_user"
.IP "\(bu" 4
List events for an organization
.Sp
.Vb 1
\&    GET /users/:user/events/orgs/:org
.Ve
.Sp
Examples:
.Sp
.Vb 5
\&    my $e = Pithub::Events\->new;
\&    my $result = $e\->org(
\&        org  => \*(AqCPAN\-API\*(Aq,
\&        user => \*(Aqplu\*(Aq,
\&    );
.Ve
.SS "public"
.IX Subsection "public"
.IP "\(bu" 4
List public events
.Sp
.Vb 1
\&    GET /events
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->public;
.Ve
.SS "repos"
.IX Subsection "repos"
.IP "\(bu" 4
List repository events
.Sp
.Vb 1
\&    GET /repos/:user/:repo/events
.Ve
.Sp
Examples:
.Sp
.Vb 5
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->repos(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&    );
.Ve
.SS "user_performed"
.IX Subsection "user_performed"
.IP "\(bu" 4
List events performed by a user
.Sp
.Vb 1
\&    GET /users/:user/events
.Ve
.Sp
If you are authenticated as the given user, you will see your
private events. Otherwise, you'll only see public events.
.Sp
Examples:
.Sp
.Vb 2
\&    my $e = Pithub::Events\->new;
\&    my $result = $e\->user_performed( user => \*(Aqplu\*(Aq );
\&
\&    # List public events performed by a user
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->user_performed(
\&        user   => \*(Aqplu\*(Aq,
\&        public => 1,
\&    );
.Ve
.SS "user_received"
.IX Subsection "user_received"
.IP "\(bu" 4
List events that a user has received
.Sp
.Vb 1
\&    GET /users/:user/received_events
.Ve
.Sp
These are events that you've received by watching repos and
following users. If you are authenticated as the given user,
you will see private events. Otherwise, you'll only see
public events.
.Sp
Examples:
.Sp
.Vb 2
\&    my $e = Pithub::Events\->new;
\&    my $result = $e\->user_received( user => \*(Aqplu\*(Aq );
\&
\&    # List public events that a user has received
\&    my $e      = Pithub::Events\->new;
\&    my $result = $e\->user_received(
\&        user   => \*(Aqplu\*(Aq,
\&        public => 1,
\&    );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Johannes Plunien <plu@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Johannes Plunien.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.