.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Net::GitHub::V4 3pm" .TH Net::GitHub::V4 3pm "2018-04-07" "perl v5.26.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" Net::GitHub::V4 \- GitHub GraphQL API .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& use Net::GitHub::V4; \& my $gh = Net::GitHub::V4\->new( \& access_token => $oauth_token \& ); \& \& my $data = $gh\->query(<<\*(AqIQL\*(Aq); \&query { \& repository(owner: "octocat", name: "Hello\-World") { \& pullRequests(last: 10) { \& edges { \& node { \& number \& mergeable \& } \& } \& } \& } \&} \&IQL \& \& # mutation \& $data = $gh\->query(<<\*(AqIQL\*(Aq); \&mutation AddCommentToIssue { \& addComment(input:{subjectId:"MDU6SXNzdWUyMzA0ODQ2Mjg=", body:"A shiny new comment! :tada:"}) { \& commentEdge { \& cursor \& } \& subject { \& id \& } \& timelineEdge { \& cursor \& } \& } \&} \&IQL \& \& # variables \& $data = $gh\->query(<<\*(AqIQL\*(Aq, { number_of_repos => 3 }); \&query($number_of_repos:Int!) { \& viewer { \& name \& repositories(last: $number_of_repos) { \& nodes { \& name \& } \& } \& } \&} \&IQL .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .SS "\s-1ATTRIBUTES\s0" .IX Subsection "ATTRIBUTES" \fIAuthentication\fR .IX Subsection "Authentication" .IP "access_token" 4 .IX Item "access_token" .Vb 1 \& my $gh = Net::GitHub::V4\->new( access_token => $ENV{GITHUB_ACCESS_TOKEN} ); .Ve .PP \fIraw_response\fR .IX Subsection "raw_response" .PP .Vb 4 \& my $gh = Net::GitHub::V4\->new( \& # login/pass or access_token \& raw_response => 1 \& ); .Ve .PP return raw HTTP::Response object .PP \fIraw_string\fR .IX Subsection "raw_string" .PP .Vb 4 \& my $gh = Net::GitHub::V4\->new( \& # login/pass or access_token \& raw_string => 1 \& ); .Ve .PP return HTTP::Response response content as string .PP \fIapi_throttle\fR .IX Subsection "api_throttle" .PP .Vb 4 \& my $gh = Net::GitHub::V4\->new( \& # login/pass or access_token \& api_throttle => 0 \& ); .Ve .PP To disable call rate limiting (e.g. if your account is whitelisted), set \fBapi_throttle\fR to 0. .PP \fIua\fR .IX Subsection "ua" .PP To set the proxy for ua, you can do something like following .PP .Vb 1 \& $gh\->ua\->proxy(\*(Aqhttps\*(Aq, \*(Aqsocks://127.0.0.1:9050\*(Aq); .Ve .PP \&\f(CW$gh\fR\->ua is an instance of LWP::UserAgent .SS "\s-1METHODS\s0" .IX Subsection "METHODS" \fIquery($method, \f(CI$url\fI, \f(CI$data\fI)\fR .IX Subsection "query($method, $url, $data)" .PP .Vb 10 \& my $data = $gh\->query(<