.\" 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::Issues 3pm"
.TH Pithub::Issues 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::Issues \- Github v3 Issues API
.SH "VERSION"
.IX Header "VERSION"
version 0.01036
.SH "METHODS"
.IX Header "METHODS"
.SS "assignees"
.IX Subsection "assignees"
Provides access to Pithub::Issues::Assignees.
.SS "comments"
.IX Subsection "comments"
Provides access to Pithub::Issues::Comments.
.SS "create"
.IX Subsection "create"
.IP "\(bu" 4
Create an issue
.Sp
.Vb 1
\&    POST /repos/:user/:repo/issues
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBtitle\fR: mandatory string
.IP "\(bu" 4
\&\fBbody\fR: optional string
.IP "\(bu" 4
\&\fBassignee\fR: optional string \- Login for the user that this issue
should be assigned to.
.IP "\(bu" 4
\&\fBmilestone\fR: optional number \- Milestone to associate this issue
with.
.IP "\(bu" 4
\&\fBlabels\fR: optional arrayref of strings \- Labels to associate with this
issue.
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 12
\&    my $i = Pithub::Issues\->new;
\&    my $result = $i\->create(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        data => {
\&            assignee  => \*(Aqoctocat\*(Aq,
\&            body      => "I\*(Aqm having a problem with this.",
\&            labels    => [ \*(AqLabel1\*(Aq, \*(AqLabel2\*(Aq ],
\&            milestone => 1,
\&            title     => \*(AqFound a bug\*(Aq
\&        }
\&    );
.Ve
.Sp
Response: \fBStatus: 201 Created\fR
.Sp
.Vb 10
\&    {
\&        "url": "https://api.github.com/repos/octocat/Hello\-World/issues/1",
\&        "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&        "number": 1347,
\&        "state": "open",
\&        "title": "Found a bug",
\&        "body": "I\*(Aqm having a problem with this.",
\&        "user": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "labels": [
\&        {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/labels/bug",
\&            "name": "bug",
\&            "color": "f29513"
\&        }
\&        ],
\&        "assignee": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "milestone": {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/milestones/1",
\&            "number": 1,
\&            "state": "open",
\&            "title": "v1.0",
\&            "description": "",
\&            "creator": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "open_issues": 4,
\&            "closed_issues": 8,
\&            "created_at": "2011\-04\-10T20:09:31Z",
\&            "due_on": null
\&        },
\&        "comments": 0,
\&        "pull_request": {
\&            "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&            "diff_url": "https://github.com/octocat/Hello\-World/issues/1.diff",
\&            "patch_url": "https://github.com/octocat/Hello\-World/issues/1.patch"
\&        },
\&        "closed_at": null,
\&        "created_at": "2011\-04\-22T13:33:48Z",
\&        "updated_at": "2011\-04\-22T13:33:48Z"
\&    }
.Ve
.RE
.SS "events"
.IX Subsection "events"
Provides access to Pithub::Issues::Events.
.SS "get"
.IX Subsection "get"
.IP "\(bu" 4
Get a single issue
.Sp
.Vb 1
\&    GET /repos/:user/:repo/issues/:id
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBissue_id\fR: mandatory integer
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 6
\&    my $i = Pithub::Issues\->new;
\&    my $result = $i\->get(
\&        user => \*(Aqplu\*(Aq,
\&        repo => \*(AqPithub\*(Aq,
\&        issue_id => 1,
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    {
\&        "url": "https://api.github.com/repos/octocat/Hello\-World/issues/1",
\&        "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&        "number": 1347,
\&        "state": "open",
\&        "title": "Found a bug",
\&        "body": "I\*(Aqm having a problem with this.",
\&        "user": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "labels": [
\&        {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/labels/bug",
\&            "name": "bug",
\&            "color": "f29513"
\&        }
\&        ],
\&        "assignee": {
\&            "login": "octocat",
\&            "id": 1,
\&            "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&            "url": "https://api.github.com/users/octocat"
\&        },
\&        "milestone": {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/milestones/1",
\&            "number": 1,
\&            "state": "open",
\&            "title": "v1.0",
\&            "description": "",
\&            "creator": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "open_issues": 4,
\&            "closed_issues": 8,
\&            "created_at": "2011\-04\-10T20:09:31Z",
\&            "due_on": null
\&        },
\&        "comments": 0,
\&        "pull_request": {
\&            "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&            "diff_url": "https://github.com/octocat/Hello\-World/issues/1.diff",
\&            "patch_url": "https://github.com/octocat/Hello\-World/issues/1.patch"
\&        },
\&        "closed_at": null,
\&        "created_at": "2011\-04\-22T13:33:48Z",
\&        "updated_at": "2011\-04\-22T13:33:48Z"
\&    }
.Ve
.RE
.SS "labels"
.IX Subsection "labels"
Provides access to Pithub::Issues::Labels.
.SS "list"
.IX Subsection "list"
.IP "\(bu" 4
List the issues of the authenticated user
.Sp
.Vb 1
\&    GET /issues
.Ve
.Sp
This \s-1API\s0 call can be influenced via the \f(CW\*(C`params\*(C'\fR
hashref with following parameters:
.RS 4
.IP "\(bu" 4
\&\fBfilter\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBassigned\fR: Issues assigned to you (default)
.IP "\(bu" 4
\&\fBcreated\fR: Issues created by you
.IP "\(bu" 4
\&\fBmentioned\fR: Issues mentioning you
.IP "\(bu" 4
\&\fBsubscribed\fR: Issues you're subscribed to updates for
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBstate\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBopen\fR (default)
.IP "\(bu" 4
\&\fBclosed\fR
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBlabels\fR: String list of comma separated Label names.
Example: \f(CW\*(C`bug,ui,@high\*(C'\fR
.IP "\(bu" 4
\&\fBsort\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBcreated\fR (default)
.IP "\(bu" 4
\&\fBupdated\fR
.IP "\(bu" 4
\&\fBcomments\fR
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBdirection\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBasc\fR
.IP "\(bu" 4
\&\fBdesc\fR (default)
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBsince\fR: optional string of a timestamp in \s-1ISO 8601\s0 format: \s-1YYYY\-MM\-DDTHH:MM:SSZ\s0
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 10
\&    my $i      = Pithub::Issues\->new;
\&    my $result = $i\->list(
\&        params => {
\&            filter    => \*(Aqassigned\*(Aq,
\&            state     => \*(Aqopen\*(Aq,
\&            labels    => \*(Aqbug\*(Aq,
\&            sort      => \*(Aqupdated\*(Aq,
\&            direction => \*(Aqasc\*(Aq,
\&        }
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    [
\&        {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/issues/1",
\&            "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&            "number": 1347,
\&            "state": "open",
\&            "title": "Found a bug",
\&            "body": "I\*(Aqm having a problem with this.",
\&            "user": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "labels": [
\&            {
\&                "url": "https://api.github.com/repos/octocat/Hello\-World/labels/bug",
\&                "name": "bug",
\&                "color": "f29513"
\&            }
\&            ],
\&            "assignee": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "milestone": {
\&                "url": "https://api.github.com/repos/octocat/Hello\-World/milestones/1",
\&                "number": 1,
\&                "state": "open",
\&                "title": "v1.0",
\&                "description": "",
\&                "creator": {
\&                    "login": "octocat",
\&                    "id": 1,
\&                    "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                    "url": "https://api.github.com/users/octocat"
\&                },
\&                "open_issues": 4,
\&                "closed_issues": 8,
\&                "created_at": "2011\-04\-10T20:09:31Z",
\&                "due_on": null
\&            },
\&            "comments": 0,
\&            "pull_request": {
\&                "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&                "diff_url": "https://github.com/octocat/Hello\-World/issues/1.diff",
\&                "patch_url": "https://github.com/octocat/Hello\-World/issues/1.patch"
\&            },
\&            "closed_at": null,
\&            "created_at": "2011\-04\-22T13:33:48Z",
\&            "updated_at": "2011\-04\-22T13:33:48Z"
\&        }
\&    ]
.Ve
.RE
.IP "\(bu" 4
List issues for a repository
.Sp
.Vb 1
\&    GET /repos/:user/:repo/issues
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.RE
.RS 4
.Sp
This \s-1API\s0 call can be influenced via the \f(CW\*(C`params\*(C'\fR
hashref with following parameters:
.IP "\(bu" 4
\&\fBmilestone\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`Integer\*(C'\fR Milestone number
.IP "\(bu" 4
\&\f(CW\*(C`none\*(C'\fR for Issues with no Milestone
.IP "\(bu" 4
\&\f(CW\*(C`*\*(C'\fR for Issues with any Milestone
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBstate\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBopen\fR (default)
.IP "\(bu" 4
\&\fBclosed\fR
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBassignee\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`String\*(C'\fR User login
.IP "\(bu" 4
\&\f(CW\*(C`none\*(C'\fR for Issues with no assigned User
.IP "\(bu" 4
\&\f(CW\*(C`*\*(C'\fR for Issues with any assigned User
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBmentioned\fR: String User login
.IP "\(bu" 4
\&\fBlabels\fR: String list of comma separated Label names.
Example: \f(CW\*(C`bug,ui,@high\*(C'\fR
.IP "\(bu" 4
\&\fBsort\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBcreated\fR (default)
.IP "\(bu" 4
\&\fBupdated\fR
.IP "\(bu" 4
\&\fBcomments\fR
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBdirection\fR: one of the following:
.RS 4
.IP "\(bu" 4
\&\fBasc\fR
.IP "\(bu" 4
\&\fBdesc\fR (default)
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fBsince\fR: optional string of a timestamp in \s-1ISO 8601\s0 format: \s-1YYYY\-MM\-DDTHH:MM:SSZ\s0
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 12
\&    my $i      = Pithub::Issues\->new;
\&    my $result = $i\->list(
\&        user    => \*(Aqplu\*(Aq,
\&        repo    => \*(AqPithub\*(Aq,
\&        params => {
\&            milestone => 42,
\&            state     => \*(Aqopen\*(Aq,
\&            labels    => \*(Aqbug\*(Aq,
\&            sort      => \*(Aqupdated\*(Aq,
\&            direction => \*(Aqasc\*(Aq,
\&        }
\&    );
.Ve
.Sp
Response: \fBStatus: 200 \s-1OK\s0\fR
.Sp
.Vb 10
\&    [
\&        {
\&            "url": "https://api.github.com/repos/octocat/Hello\-World/issues/1",
\&            "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&            "number": 1347,
\&            "state": "open",
\&            "title": "Found a bug",
\&            "body": "I\*(Aqm having a problem with this.",
\&            "user": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "labels": [
\&            {
\&                "url": "https://api.github.com/repos/octocat/Hello\-World/labels/bug",
\&                "name": "bug",
\&                "color": "f29513"
\&            }
\&            ],
\&            "assignee": {
\&                "login": "octocat",
\&                "id": 1,
\&                "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                "url": "https://api.github.com/users/octocat"
\&            },
\&            "milestone": {
\&                "url": "https://api.github.com/repos/octocat/Hello\-World/milestones/1",
\&                "number": 1,
\&                "state": "open",
\&                "title": "v1.0",
\&                "description": "",
\&                "creator": {
\&                    "login": "octocat",
\&                    "id": 1,
\&                    "gravatar_url": "https://github.com/images/error/octocat_happy.gif",
\&                    "url": "https://api.github.com/users/octocat"
\&                },
\&                "open_issues": 4,
\&                "closed_issues": 8,
\&                "created_at": "2011\-04\-10T20:09:31Z",
\&                "due_on": null
\&            },
\&            "comments": 0,
\&            "pull_request": {
\&                "html_url": "https://github.com/octocat/Hello\-World/issues/1",
\&                "diff_url": "https://github.com/octocat/Hello\-World/issues/1.diff",
\&                "patch_url": "https://github.com/octocat/Hello\-World/issues/1.patch"
\&            },
\&            "closed_at": null,
\&            "created_at": "2011\-04\-22T13:33:48Z",
\&            "updated_at": "2011\-04\-22T13:33:48Z"
\&        }
\&    ]
.Ve
.RE
.SS "milestones"
.IX Subsection "milestones"
Provides access to Pithub::Issues::Milestones.
.SS "update"
.IX Subsection "update"
.IP "\(bu" 4
Edit an issue
.Sp
.Vb 1
\&    PATCH /repos/:user/:repo/issues/:id
.Ve
.Sp
Parameters:
.RS 4
.IP "\(bu" 4
\&\fBuser\fR: mandatory string
.IP "\(bu" 4
\&\fBrepo\fR: mandatory string
.IP "\(bu" 4
\&\fBdata\fR: mandatory hashref, having following keys:
.RS 4
.IP "\(bu" 4
\&\fBtitle\fR: mandatory string
.IP "\(bu" 4
\&\fBbody\fR: optional string
.IP "\(bu" 4
\&\fBassignee\fR: optional string \- Login for the user that this issue
should be assigned to.
.IP "\(bu" 4
\&\fBmilestone\fR: optional number \- Milestone to associate this issue
with.
.IP "\(bu" 4
\&\fBlabels\fR: optional arrayref of strings \- Labels to associate with
this issue. Pass one or more Labels to replace the set of Labels
on this Issue. Send an empty arrayref (\f(CW\*(C`[]\*(C'\fR) to clear all
Labels from the Issue.
.RE
.RS 4
.RE
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 10
\&    my $i = Pithub::Issues\->new;
\&    my $result = $i\->update(
\&        user     => \*(Aqplu\*(Aq,
\&        repo     => \*(AqPithub\*(Aq,
\&        issue_id => 1,
\&        data     => {
\&            assignee  => \*(Aqoctocat\*(Aq,
\&            body      => "I\*(Aqm having a problem with this.",
\&            labels    => [ \*(AqLabel1\*(Aq, \*(AqLabel2\*(Aq ],
\&            milestone => 1,
\&            state     => \*(Aqopen\*(Aq,
\&            title     => \*(AqFound a bug\*(Aq
\&        }
\&    );
.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.