Net::Twitter::API - phpMan

NAME
    Net::Twitter::API - Moose sugar for defining Twitter API methods

VERSION
    version 4.01043

SYNOPSIS
      package My::Twitter::API;
      use Moose::Role;
      use Net::Twitter::API;

      use namespace::autoclean;

      has apiurl => ( isa => 'Str', is => 'rw', default => 'http://twitter.com' );

      base_url 'apiurl';

      twitter_api_method friends_timeline => (
          description => <<'',
      Returns the 20 most recent statuses posted by the authenticating user
      and that user's friends. This is the equivalent of /home on the Web.

          aliases   => [qw/following_timeline/],
          path      => 'statuses/friends_timeline',
          method    => 'GET',
          params    => [qw/since_id max_id count page/],
          required  => [],
          returns   => 'ArrayRef[Status]',
      );

      1;

DESCRIPTION
    This module provides some Moose sugar for defining Twitter API methods.
    It is part of the Net-Twitter distribution on CPAN and is used by
    "Net::Twitter::API::RESTv1_1", "Net::Twitter::API::Search", and perhaps
    others.

    It's intent is to make maintaining "Net::Twitter" as easy as possible.

METHODS
    base_url
        Specifies, by name, the attribute which contains the base URL for
        the defined API.

    twitter_api_method
        Defines a Twitter API method. Valid arguments are:

        authenticate
            Specifies whether, by default, API methods calls should
            authenticate.

        datetime_parser
            Specifies the Date::Time::Format derived parser to use for
            parsing and formatting date strings for the API being defined.

        description
            A string describing the method, suitable for documentation.

        aliases
            An ARRAY ref of strings containing alternate names for the
            method.

        path
            A string containing the path part of the API URL

        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 ".json".

        method
            A string containing the HTTP method for the call. Defaults to
            "GET".

        add_source
            A boolean, indicating whether or not the "source" parameter
            should be added to the API call. (The source value is assigned
            by Twitter for registered applications.) Defaults to 0.

        params
            An ARRAY ref of strings naming all of the valid parameters.
            Defaults to an empty ARRAY ref.

        required
            An ARRAY ref of strings naming all of the required parameters.
            Defaults to an empty ARRAY ref.

        returns
            A string describing the return type of the API method call.

        deprecated
            A boolean indicating whether or not this API is deprecated. If
            set to 1, code for the method will be created. This option is
            optional, and is used by the "Net-Twitter" distribution when
            generating documentation. It defaults to 0.

AUTHOR
    Marc Mims <marc AT questright.com>

LICENSE
    Copyright (c) 2016 Marc Mims

    The Twitter API itself, and the description text used in this module is:

    Copyright (c) 2009 Twitter

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

DISCLAIMER OF WARRANTY
    BECAUSE 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 "AS IS" 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.

    IN 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 (INCLUDING 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), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.