.\" 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::Gists::Comments 3pm"
.TH Pithub::Gists::Comments 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::Gists::Comments \- Github v3 Gist Comments API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "create"
.IX Subsection "create"
.IP "\(bu" 4
Create a comment
.Sp
.Vb 1
\&    POST /gists/:gist_id/comments
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBgist_id\fR: mandatory string
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBbody\fR: mandatory string
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 5
\&    my $c = Pithub::Gists::Comments\->new;
\&    my $result = $c\->create(
\&        gist_id => \*(Aqc0ff33\*(Aq,
\&        data    => { body => \*(AqJust commenting for the sake of commenting\*(Aq },
\&    );
.Ve
.Sp
Response: \fBStatus: 201 Created\fR
.Sp
.Vb 12
\&    {
\&        "id": 1,
\&        "url": "https://api.github.com/gists/c0ff33/comments/1",
\&        "body": "Just commenting for the sake of commenting",
\&        "user": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "created_at": "2011\-04\-18T23:23:56Z"
\&    }
.Ve
.RE
.SS "delete"
.IX Subsection "delete"
.IP "\(bu" 4
Delete a comment
.Sp
.Vb 1
\&    DELETE /gists/:gist_id/comments/:id
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBgist_id\fR: mandatory string
.IP "\(bu" 4
\&\fBcomment_id\fR: mandatory integer
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 5
\&    my $c = Pithub::Gists::Comments\->new;
\&    my $result = $c\->delete(
\&        gist_id    => \*(Aqc0ff33\*(Aq,
\&        comment_id => 1
\&    );
.Ve
.Sp
Response: \fBStatus: 204 No Content\fR
.RE
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a single comment
.Sp
.Vb 1
\&    GET /gists/:gist_id/comments/:id
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBgist_id\fR: mandatory string
.IP "\(bu" 4
\&\fBcomment_id\fR: mandatory integer
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 5
\&    my $c = Pithub::Gists::Comments\->new;
\&    my $result = $c\->get(
\&        gist_id    => \*(Aqc0ff33\*(Aq,
\&        comment_id => 1
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 12
\&    {
\&        "id": 1,
\&        "url": "https://api.github.com/gists/c0ff33/comments/1",
\&        "body": "Just commenting for the sake of commenting",
\&        "user": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "created_at": "2011\-04\-18T23:23:56Z"
\&    }
.Ve
.RE
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
List comments on a gist
.Sp
.Vb 1
\&    GET /gists/:gist_id/comments
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBgist_id\fR: mandatory string
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 2
\&    my $c = Pithub::Gists::Comments\->new;
\&    my $result = $c\->list( gist_id => 1 );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    [
\&        {
\&            "id": 1,
\&            "url": "https://api.github.com/gists/c0ff33/comments/1",
\&            "body": "Just commenting for the sake of commenting",
\&            "user": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "created_at": "2011\-04\-18T23:23:56Z"
\&        }
\&    ]
.Ve
.RE
.SS "update"
.IX Subsection "update"
.IP "\(bu" 4
Edit a comment
.Sp
.Vb 1
\&    PATCH /gists/:gist_id/comments/:id
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBgist_id\fR: mandatory string
.IP "\(bu" 4
\&\fBcomment_id\fR: mandatory integer
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBbody\fR: mandatory string
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 6
\&    my $c = Pithub::Gists::Comments\->new;
\&    my $result = $c\->update(
\&        gist_id    => \*(Aqc0ff33\*(Aq,
\&        comment_id => 1,
\&        data       => { body => \*(Aqsome comment\*(Aq }
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 12
\&    {
\&        "id": 1,
\&        "url": "https://api.github.com/gists/c0ff33/comments/1",
\&        "body": "Just commenting for the sake of commenting",
\&        "user": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "created_at": "2011\-04\-18T23:23:56Z"
\&    }
.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\-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.