.\" 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
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Twitter::API::Role::RequestArgs 3pm"
.TH Twitter::API::Role::RequestArgs 3pm "2018-10-05" "perl v5.26.2" "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"
Twitter::API::Role::RequestArgs \- API request method helpers
.SH "VERSION"
.IX Header "VERSION"
version 1.0005
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package MyApiMethods;
\&    use Moo::Role;
\&
\&    sub timeline {
\&        shift\->request_with_id(get => \*(Aqstatuses/user_timeline, @_);
\&    }
.Ve
.PP
Then, in your application code:
.PP
.Vb 1
\&    use Twitter::API;
\&
\&    my $client = Twitter::API\->new_with_traits(
\&        traits => \*(Aq+MyApiMethods\*(Aq,
\&        %othe_new_options,
\&    );
\&
\&    my $statuses = $client\->timeline(\*(Aqsemifor\*(Aq);
\&
\&    # equivalent to:
\&    my $statuses = $client\->get(\*(Aqstatuses/user_timeline\*(Aq, {
\&        screen_name => \*(Aqsemifor\*(Aq,
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Helper methods for implementers of custom traits for creating concise Twitter
\&\s-1API\s0 methods. Used in Twitter::API::Trait::ApiMethods.
.SH "METHODS"
.IX Header "METHODS"
.SS "request_with_id"
.IX Subsection "request_with_id"
Transforms an argument list with a required \f(CW\*(C`screen_name\*(C'\fR or \f(CW\*(C`user_id\*(C'\fR,
optionally passed as a leading, positional argument, a hashref argument.
.PP
If a hashref follows the optional plain scalar, the user_id or screen_name is
added to it. Otherwise a new hashref is created and inserted into \f(CW@_\fR.
.PP
If the optional plain scalar argument is missing, and there is hashref of
arguments, or if the hashref does not contain the key \f(CW\*(C`screen_name\*(C'\fR or
\&\f(CW\*(C`user_id\*(C'\fR, request_with_id croaks.
.PP
Examples:
.PP
.Vb 3
\&    $self\->request_with_id(get => \*(Aqsome/endpoint\*(Aq, \*(Aqfoo\*(Aq);
\&    # is transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, { screen_name => \*(Aqfoo\*(Aq });
\&
\&    $self\->request_with_id(get => \*(Aqsome/endpoint\*(Aq, 8575429);
\&    # is transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, { user_id => 8675429 });
\&
\&    $self\->request_with_id(get => \*(Aqsome/endpoint\*(Aq, {
\&        screen_name => \*(Aqsemifor\*(Aq,
\&    });
\&    # is transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, { screen_name => \*(Aqsemifor\*(Aq });
\&
\&    $self\->request_with_id(get => \*(Aqsome/endpoint\*(Aq, {
\&        foo => \*(Aqbar\*(Aq,
\&    }); ### croaks ###
.Ve
.SS "request_with_pos_args"
.IX Subsection "request_with_pos_args"
Transforms a list of required arguments, optionally provided positionally in a
determined order, into a hashref of named arguments. If a hashref follows the
positional arguments, the named arguments are added to it. Otherwise, a new
hashref in inserted into \f(CW@_\fR.
.PP
Zero or more of the required arguments may be provided positionally, as long as
the appear in the specified order. I any of the required arguments are not
provided positionally, they must be provided in the hashref or
request_with_pos_args croaks.
.PP
The positional name \f(CW\*(C`:ID\*(C'\fR is treated specially. It is transformed to
\&\f(CW\*(C`user_id\*(C'\fR if the value it represents contains only digits. Otherwise, it is
transformed to \f(CW\*(C`screen_name\*(C'\fR.
.PP
Examples:
.PP
.Vb 9
\&    $self\->request_with_pos_args(
\&        [ \*(Aqid\*(Aq, \*(Aqname\*(Aq ], get => \*(Aqsome/endpoint\*(Aq,
\&        \*(Aq007\*(Aq, \*(AqBond\*(Aq
\&    );
\&    # is transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, {
\&        id   => \*(Aq007\*(Aq,
\&        name => \*(AqBond\*(Aq,
\&    });
\&
\&    $self\->request_with_pos_args(
\&        [ \*(Aqid\*(Aq, \*(Aqname\*(Aq ], get => \*(Aqsome/endpoint\*(Aq,
\&        \*(Aq007\*(Aq, { name => \*(AqBond\*(Aq }
\&    );
\&    # is also transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, {
\&        id   => \*(Aq007\*(Aq,
\&        name => \*(AqBond\*(Aq,
\&    });
\&
\&    $self\->request_with_pos_args(
\&        [ \*(Aq:ID\*(Aq, \*(Aqstatus\*(Aq ], get => \*(Aqsome/endpoint\*(Aq,
\&        \*(Aqalice\*(Aq, \*(Aqdown the rabbit hole\*(Aq
\&    );
\&    # is transformed to:
\&    $self\->request(get => \*(Aqsome/endpoint\*(Aq, {
\&        sreen_name => \*(Aqalice\*(Aq,
\&        status     => \*(Aqdown the rabbit hole\*(Aq,
\&    });
.Ve
.SS "normalize_pos_args"
.IX Subsection "normalize_pos_args"
Helper method for \f(CW\*(C`request_with_pos_args\*(C'\fR. Takes the same arguments described in
\&\f(CW\*(C`request_with_pos_args\*(C'\fR above, and returns a list of arguments ready for a
call to \f(CW\*(C`request\*(C'\fR.
.PP
Individual methods in Twitter::API::Trait::ApiMethods use
\&\f(CW\*(C`normalize_pos_args\*(C'\fR if they need to do further processing on the args hashref
before calling \f(CW\*(C`request\*(C'\fR.
.ie n .SS "flatten_list_args([ $key | \e@keys ], \e%args)"
.el .SS "flatten_list_args([ \f(CW$key\fP | \e@keys ], \e%args)"
.IX Subsection "flatten_list_args([ $key | @keys ], %args)"
Some Twitter \s-1API\s0 arguments take a list of values as a string of comma separated
items. To allow callers to pass an array reference of items instead, this
method is used to flatten array references to strings. The key or keys identify
which values to flatten in the \f(CW\*(C`\e%args\*(C'\fR hash reference, if they exist.
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015\-2018 by Marc Mims.
.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.