.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Net::Twitter::API 3pm"
.TH Net::Twitter::API 3pm "2022-06-16" "perl v5.34.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"
Net::Twitter::API \- Moose sugar for defining Twitter API methods
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  package My::Twitter::API;
\&  use Moose::Role;
\&  use Net::Twitter::API;
\&
\&  use namespace::autoclean;
\&
\&  has apiurl => ( isa => \*(AqStr\*(Aq, is => \*(Aqrw\*(Aq, default => \*(Aqhttp://twitter.com\*(Aq );
\&
\&  base_url \*(Aqapiurl\*(Aq;
\&
\&  twitter_api_method friends_timeline => (
\&      description => <<\*(Aq\*(Aq,
\&  Returns the 20 most recent statuses posted by the authenticating user
\&  and that user\*(Aqs friends. This is the equivalent of /home on the Web.
\&
\&      aliases   => [qw/following_timeline/],
\&      path      => \*(Aqstatuses/friends_timeline\*(Aq,
\&      method    => \*(AqGET\*(Aq,
\&      params    => [qw/since_id max_id count page/],
\&      required  => [],
\&      returns   => \*(AqArrayRef[Status]\*(Aq,
\&  );
\&
\&  1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides some Moose sugar for defining Twitter \s-1API\s0 methods.  It is part
of the Net-Twitter distribution on \s-1CPAN\s0 and is used by \f(CW\*(C`Net::Twitter::API::RESTv1_1\*(C'\fR,
\&\f(CW\*(C`Net::Twitter::API::Search\*(C'\fR, and perhaps others.
.PP
It's intent is to make maintaining \f(CW\*(C`Net::Twitter\*(C'\fR as easy as possible.
.SH "METHODS"
.IX Header "METHODS"
.IP "base_url" 4
.IX Item "base_url"
Specifies, by name, the attribute which contains the base \s-1URL\s0 for the defined \s-1API.\s0
.IP "twitter_api_method" 4
.IX Item "twitter_api_method"
Defines a Twitter \s-1API\s0 method.  Valid arguments are:
.RS 4
.IP "authenticate" 4
.IX Item "authenticate"
Specifies whether, by default, \s-1API\s0 methods calls should authenticate.
.IP "datetime_parser" 4
.IX Item "datetime_parser"
Specifies the Date::Time::Format derived parser to use for parsing and
formatting date strings for the \s-1API\s0 being defined.
.IP "description" 4
.IX Item "description"
A string describing the method, suitable for documentation.
.IP "aliases" 4
.IX Item "aliases"
An \s-1ARRAY\s0 ref of strings containing alternate names for the method.
.IP "path" 4
.IX Item "path"
A string containing the path part of the \s-1API URL\s0
.IP "path_suffix" 4
.IX Item "path_suffix"
A string containing an additional suffix to append to the path (for
legacy reasons).  If you want to suffix appended, pass the empty
string.  Defaults to \*(L".json\*(R".
.IP "method" 4
.IX Item "method"
A string containing the \s-1HTTP\s0 method for the call.  Defaults to \*(L"\s-1GET\*(R".\s0
.IP "add_source" 4
.IX Item "add_source"
A boolean, indicating whether or not the \f(CW\*(C`source\*(C'\fR parameter should be added
to the \s-1API\s0 call.  (The source value is assigned by Twitter for registered
applications.)  Defaults to 0.
.IP "params" 4
.IX Item "params"
An \s-1ARRAY\s0 ref of strings naming all of the valid parameters.  Defaults to an
empty \s-1ARRAY\s0 ref.
.IP "required" 4
.IX Item "required"
An \s-1ARRAY\s0 ref of strings naming all of the required parameters.  Defaults to an
empty \s-1ARRAY\s0 ref.
.IP "returns" 4
.IX Item "returns"
A string describing the return type of the \s-1API\s0 method call.
.IP "deprecated" 4
.IX Item "deprecated"
A boolean indicating whether or not this \s-1API\s0 is deprecated.  If set to 1, code
for the method will be created.  This option is optional, and is used by the
\&\f(CW\*(C`Net\-Twitter\*(C'\fR distribution when generating documentation.  It defaults to 0.
.RE
.RS 4
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2016 Marc Mims
.PP
The Twitter \s-1API\s0 itself, and the description text used in this module is:
.PP
Copyright (c) 2009 Twitter
.PP
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0