.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Contents 3pm"
.TH Pithub::Repos::Contents 3pm "2023-09-02" "perl v5.36.0" "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::Contents \- Github v3 Repo Contents API
.SH "VERSION"
.IX Header "VERSION"
version 0.01041
.SH "METHODS"
.IX Header "METHODS"
.SS "archive"
.IX Subsection "archive"
.IP "\(bu" 4
This method will return a \f(CW302\fR to a \s-1URL\s0 to download a tarball
or zipball archive for a repository.
.Sp
Note: For private repositories, these links are temporary and expire
quickly.
.Sp
.Vb 1
\&    GET /repos/:user/:repo/:archive_format/:ref
.Ve
.Sp
The \f(CW\*(C`ref\*(C'\fR parameter is optional and will default to
\&\f(CW\*(C`master\*(C'\fR.
.Sp
Examples:
.Sp
.Vb 1
\&    use Path::Tiny;
\&
\&    my $c = Pithub::Repos::Contents\->new(
\&        repo => \*(AqPithub\*(Aq,
\&        user => \*(Aqplu\*(Aq
\&    );
\&
\&    my $result = $c\->archive( archive_format => \*(Aqtarball\*(Aq );
\&    if ( $result\->success ) {
\&        path(\*(AqPithub\-master.tgz\*(Aq)\->spew($result\->raw_content);
\&    }
\&
\&    $result = $c\->archive( archive_format => \*(Aqtarball\*(Aq, ref => \*(Aqother_branch\*(Aq );
\&    if ( $result\->success ) {
\&        path(\*(AqPithub\-other_branch.tgz\*(Aq)\->spew($result\->raw_content);
\&    }
.Ve
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
This method returns the contents of any file or directory in a
repository.
.Sp
.Vb 1
\&    GET /repos/:user/:repo/contents/:path
.Ve
.Sp
Optional Parameters:
.RS 4
.IP "\(bu" 4
\&\fBref\fR: Optional string \- The String name of the
Commit/Branch/Tag. Defaults to \f(CW\*(C`master\*(C'\fR.
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 4
\&    my $c = Pithub::Repos::Contents\->new(
\&        repo => \*(AqPithub\*(Aq,
\&        user => \*(Aqplu\*(Aq
\&    );
\&
\&    # List all files/directories in the repo root
\&    my $result = $c\->get;
\&    if ( $result\->success ) {
\&        say $_\->{name} for @{ $result\->content };
\&    }
\&
\&    # Get the Pithub.pm file
\&    $result = $c\->get( path => \*(Aqlib/Pithub.pm\*(Aq );
\&    print Dumper $result\->content if $result\->success;
.Ve
.RE
.SS "readme"
.IX Subsection "readme"
.IP "\(bu" 4
This method returns the preferred \s-1README\s0 for a repository.
.Sp
.Vb 1
\&    GET /repos/:user/:repo/readme
.Ve
.Sp
Optional Parameters:
.RS 4
.IP "\(bu" 4
\&\fBref\fR: Optional string \- The String name of the
Commit/Branch/Tag. Defaults to \f(CW\*(C`master\*(C'\fR.
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 4
\&    my $c = Pithub::Repos::Contents\->new(
\&        repo => \*(Aqdotfiles\*(Aq,
\&        user => \*(Aqplu\*(Aq
\&    );
\&
\&    my $result = $c\->readme;
\&    if ( $result\->success ) {
\&        print Dumper $result\->content;
\&    }
\&
\&    # Get the readme of branch \*(Aqother_branch\*(Aq
\&    $result = $c\->readme( params => { ref => \*(Aqother_branch\*(Aq } );
\&    print Dumper $result\->content if $result\->success;
.Ve
.RE
.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.