.\" Automatically generated by Pod::Man 4.10 (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
..
.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 "CloudFlare::Client 3pm"
.TH CloudFlare::Client 3pm "2018-12-20" "perl v5.28.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"
CloudFlare::Client \- Object Orientated Interface to CloudFlare client API
.SH "VERSION"
.IX Header "VERSION"
version v0.55.4
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use CloudFlare::Client;
\&
\&    my $api = CloudFlare::Client::\->new(
\&        user   => $CF_USER,
\&        apikey => $CF_KEY,);
\&    $api\->stats( z => $ZONE, interval => $INTERVAL);
\&    ...
.Ve
.SH "OVERVIEW"
.IX Header "OVERVIEW"
Please see the documentation at
<https://www.cloudflare.com/docs/client\-api.html> for information on the
CloudFlare client \s-1API\s0 and its arguments. \s-1API\s0 actions are mapped to methods of
the same name and arguments are passed in as a hash with keys as given in the
docs
.PP
Successful \s-1API\s0 calls return the response section from the upstream \s-1JSON
API.\s0 Failures for whatever reason throw exceptions under the
CloudFlare::Client::Exception:: namespace
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Construct a new \s-1API\s0 object
.PP
.Vb 3
\&    my $api = CloudFlare::Client::\->new(
\&        user   => $CF_USER,
\&        apikey => $CF_KEY);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Please see those modules/websites for more information related to this module.
.IP "\(bu" 4
Mojo::Cloudflare
.IP "\(bu" 4
WebService::CloudFlare::Host
.SH "SUPPORT"
.IX Header "SUPPORT"
.SS "Perldoc"
.IX Subsection "Perldoc"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&  perldoc CloudFlare::Client
.Ve
.SS "Websites"
.IX Subsection "Websites"
The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.
.IP "\(bu" 4
MetaCPAN
.Sp
A modern, open-source \s-1CPAN\s0 search engine, useful to view \s-1POD\s0 in \s-1HTML\s0 format.
.Sp
<http://metacpan.org/release/CloudFlare\-Client>
.SS "Email"
.IX Subsection "Email"
You can email the author of this module at \f(CW\*(C`me+dev@peter\-r.co.uk\*(C'\fR asking for help with any problems you have.
.SS "Source Code"
.IX Subsection "Source Code"
The code is open to the world, and available for you to hack on. Please feel free to browse it and play
with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull
from your repository :)
.PP
<https://github.com/pwr22/cloudflare\-client>
.PP
.Vb 1
\&  git clone git://github.com/pwr22/cloudflare\-client.git
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
https://github.com/pwr22/cloudflare\-client/issues
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to CloudFlare providing an awesome free service with an \s-1API\s0
.SH "CONTRIBUTOR"
.IX Header "CONTRIBUTOR"
Peter Roberts <me+github@peter\-r.co.uk>
.SH "AUTHOR"
.IX Header "AUTHOR"
Peter Roberts <me+dev@peter\-r.co.uk>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2016 by Peter Roberts.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The MIT (X11) License
.Ve