.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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
.\" ========================================================================
.\"
.IX Title "Pithub::Repos::Statuses 3pm"
.TH Pithub::Repos::Statuses 3pm "2021-02-15" "perl v5.32.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"
Pithub::Repos::Statuses \- Github v3 repos / statuses API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "list"
.IX Subsection "list"
Extra arguments
.IP "\(bu" 4
ref
.Sp
The \s-1SHA,\s0 branch, or tag-name to get statuses for
.PP
List statuses for a ref
.PP
.Vb 1
\&    GET /repos/:user/:repo/statuses/:ref
.Ve
.PP
Examples:
.PP
.Vb 2
\&    my $statuses = Pithub::Repos::Statuses\->new;
\&    my $result   = $statuses\->list( ref => \*(Aqmaster\*(Aq );
.Ve
.SS "create"
.IX Subsection "create"
Extra arguments
.IP "state (required)" 4
.IX Item "state (required)"
The state of the status. Can be one of 'pending', 'success', 'error' or 'failure'.
.IP "target_url" 4
.IX Item "target_url"
This \s-1URL\s0 will be used to link from the status to some related page, for instance
the build result for this specific \s-1SHA.\s0
.IP "description" 4
.IX Item "description"
A short description of the status
.PP
Add a status to a \s-1SHA.\s0
.PP
.Vb 1
\&    POST /repos/:user/:repo/statuses/:sha
.Ve
.PP
Examples:
.PP
.Vb 9
\&    my $statuses = Pithub::Repos::Statuses\->new;
\&    my $result   = $statuses\->create( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq,
\&        sha => \*(Aq0123456\*(Aq,
\&        data => {
\&            state => \*(Aqerror\*(Aq,
\&            description => \*(AqBuild failed\*(Aq,
\&            target_url => \*(Aqhttps://travis\-ci.org/some/url/0123456\*(Aq,
\&        },
\&    );
.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\-2019 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.