.\" 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 3pm"
.TH Pithub::Repos 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 \- Github v3 Repos API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "branch"
.IX Subsection "branch"
Get information about a single branch.
.PP
.Vb 1
\&    GET /repos/:owner/:repo/branches/:branch
.Ve
.PP
Example:
.PP
.Vb 5
\&    my $result = Pithub\->new\->branch(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        branch => "master"
\&    );
.Ve
.PP
See also branches to get a list of all branches.
.SS "branches"
.IX Subsection "branches"
.IP "\(bu" 4
List Branches
.Sp
.Vb 1
\&    GET /repos/:user/:repo/branches
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->branches( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.Sp
See also branch to get information about a single branch.
.SS "collaborators"
.IX Subsection "collaborators"
Provides access to Pithub::Repos::Collaborators.
.SS "commits"
.IX Subsection "commits"
Provides access to Pithub::Repos::Commits.
.SS "contents"
.IX Subsection "contents"
Provides access to Pithub::Repos::Contents.
.SS "contributors"
.IX Subsection "contributors"
.IP "\(bu" 4
List contributors
.Sp
.Vb 1
\&    GET /repos/:user/:repo/contributors
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->contributors( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "create"
.IX Subsection "create"
.IP "\(bu" 4
Create a new repository for the authenticated user.
.Sp
.Vb 1
\&    POST /user/repos
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->create( data => { name => \*(Aqsome\-repo\*(Aq } );
.Ve
.IP "\(bu" 4
Create a new repository in this organization. The authenticated user
must be a member of this organization.
.Sp
.Vb 1
\&    POST /orgs/:org/repos
.Ve
.Sp
Examples:
.Sp
.Vb 5
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->create(
\&        org  => \*(AqCPAN\-API\*(Aq,
\&        data => { name => \*(Aqsome\-repo\*(Aq }
\&    );
.Ve
.SS "delete"
.IX Subsection "delete"
Delete a repository.
.PP
.Vb 1
\&    DELETE /repos/:owner/:repo
.Ve
.SS "downloads"
.IX Subsection "downloads"
Provides access to Pithub::Repos::Downloads.
.SS "forks"
.IX Subsection "forks"
Provides access to Pithub::Repos::Forks.
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a repo
.Sp
.Vb 1
\&    GET /repos/:user/:repo
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->get( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "hooks"
.IX Subsection "hooks"
Provides access to Pithub::Repos::Hooks.
.SS "issues"
.IX Subsection "issues"
Provides access to Pithub::Issues for this repo.
.SS "keys"
.IX Subsection "keys"
Provides access to Pithub::Repos::Keys.
.SS "languages"
.IX Subsection "languages"
.IP "\(bu" 4
List languages
.Sp
.Vb 1
\&    GET /repos/:user/:repo/languages
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->languages( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
List repositories for the authenticated user.
.Sp
.Vb 1
\&    GET /user/repos
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->list;
.Ve
.IP "\(bu" 4
List public repositories for the specified user.
.Sp
.Vb 1
\&    GET /users/:user/repos
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->list( user => \*(Aqplu\*(Aq );
.Ve
.IP "\(bu" 4
List repositories for the specified org.
.Sp
.Vb 1
\&    GET /orgs/:org/repos
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->list( org => \*(AqCPAN\-API\*(Aq );
.Ve
.SS "markdown"
.IX Subsection "markdown"
Provides access to Pithub::Markdown setting the current repository as the
default context. This also sets the mode to default to 'gfm'.
.SS "pull_requests"
.IX Subsection "pull_requests"
Provides access to Pithub::PullRequests.
.SS "releases"
.IX Subsection "releases"
Provides access to Pithub::Repos::Releases.
.SS "starring"
.IX Subsection "starring"
Provides access to Pithub::Repos::Starring.
.SS "stats"
.IX Subsection "stats"
Provide access to Pithub::Repos::Stats.
.SS "statuses"
.IX Subsection "statuses"
Provide access to Pithub::Repos::Statuses.
.SS "tags"
.IX Subsection "tags"
.IP "\(bu" 4
List Tags
.Sp
.Vb 1
\&    GET /repos/:user/:repo/tags
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->tags( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "teams"
.IX Subsection "teams"
.IP "\(bu" 4
List Teams
.Sp
.Vb 1
\&    GET /repos/:user/:repo/teams
.Ve
.Sp
Examples:
.Sp
.Vb 2
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->teams( user => \*(Aqplu\*(Aq, repo => \*(AqPithub\*(Aq );
.Ve
.SS "update"
.IX Subsection "update"
.IP "\(bu" 4
Edit
.Sp
.Vb 1
\&    PATCH /repos/:user/:repo
.Ve
.Sp
Examples:
.Sp
.Vb 6
\&    # update a repo for the authenticated user
\&    my $repos  = Pithub::Repos\->new;
\&    my $result = $repos\->update(
\&        repo => \*(AqPithub\*(Aq,
\&        data => { description => \*(AqGithub API v3\*(Aq },
\&    );
.Ve
.SS "watching"
.IX Subsection "watching"
Provides access to Pithub::Repos::Watching.
.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.