Marc Mims > Net-Twitter-3.18004 > Net::Twitter::Role::API::REST

Download:
Net-Twitter-3.18004.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Source   Latest Release: Net-Twitter-4.01006
status

Required. The text of your status update. URL encode as necessary. Statuses over 140 characters will cause a 403 error to be returned from the API.

in_reply_to_status_id

Optional. The ID of an existing status that the update is in reply to. o Note: This parameter will be ignored unless the author of the tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced tweet, within the update.

lat

Optional. The location's latitude that this tweet refers to. The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding long parameter with this tweet.

long

Optional. The location's longitude that this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter with this tweet.

place_id

Optional. The place to attach to this status update. Valid place_ids can be found by querying reverse_geocode.

display_coordinates

Optional. By default, geo-tweets will have their coordinates exposed in the status object (to remain backwards compatible with existing API applications). To turn off the display of the precise latitude and longitude (but keep the contextual location information), pass display_coordinates = 0> on the status update.

EOT

);

twitter_api_method destroy_status => ( description => <<'', Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status.

    path     => 'statuses/destroy/:id',
    method   => 'POST',
    params   => [qw/id trim_user include_entities/],
    booleans => [qw/trim_user include_entities/],
    required => [qw/id/],
    returns  => 'Status',
);

twitter_api_method friends => ( deprecated => 1, description => <<'EOT', This method has been deprecated. Twitter intends to stop support for it on May 14, 2012. Use friends_ids and lookup_users instead.

Returns a reference to an array of the user's friends. If id, user_id, or screen_name is not specified, the friends of the authenticating user are returned. The returned users are ordered from most recently followed to least recently followed.

Use the optional cursor parameter to retrieve users in pages of 100. When the cursor parameter is used, the return value is a reference to a hash with keys previous_cursor, next_cursor, and users. The value of users is a reference to an array of the user's friends. The result set isn't guaranteed to be 100 every time as suspended users will be filtered out. Set the optional cursor parameter to -1 to get the first page of users. Set it to the prior return's value of previous_cursor or next_cursor to page forward or backwards. When there are no prior pages, the value of previous_cursor will be 0. When there are no subsequent pages, the value of next_cursor will be 0. EOT

    aliases  => [qw/following/],
    path     => 'statuses/friends/:id',
    method   => 'GET',
    params   => [qw/id user_id screen_name cursor include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'Hashref|ArrayRef[User]',
);

twitter_api_method followers => ( deprecated => 1, description => <<'EOT', This method has been deprecated. Twitter intends to stop support for it on May 14, 2012. Use friends_ids and lookup_users instead.

Returns a reference to an array of the user's followers. If id, user_id, or screen_name is not specified, the followers of the authenticating user are returned. The returned users are ordered from most recently followed to least recently followed.

Use the optional cursor parameter to retrieve users in pages of 100. When the cursor parameter is used, the return value is a reference to a hash with keys previous_cursor, next_cursor, and users. The value of users is a reference to an array of the user's friends. The result set isn't guaranteed to be 100 every time as suspended users will be filtered out. Set the optional cursor parameter to -1 to get the first page of users. Set it to the prior return's value of previous_cursor or next_cursor to page forward or backwards. When there are no prior pages, the value of previous_cursor will be 0. When there are no subsequent pages, the value of next_cursor will be 0. EOT

    path     => 'statuses/followers/:id',
    method   => 'GET',
    params   => [qw/id user_id screen_name cursor include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'HashRef|ArrayRef[User]',
);

twitter_api_method show_user => ( description => <<'', Returns extended information of a given user, specified by ID or screen name as per the required id parameter. This information includes design settings, so third party developers can theme their widgets according to a given user's preferences. You must be properly authenticated to request the page of a protected user.

    path     => 'users/show/:id',
    method   => 'GET',
    params   => [qw/id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'ExtendedUser',
);

twitter_api_method contributees => ( path => 'users/contributees', method => 'GET', params => [qw/user_id screen_name include_entities skip_satus/], required => [], booleans => [qw/include_entities skip_satus/], returns => 'ArrayRef[User]', description => <<'', Returns an array of users that the specified user can contribute to.

);

twitter_api_method contributors => ( path => 'users/contributors', method => 'GET', params => [qw/user_id screen_name include_entities skip_satus/], required => [], booleans => [qw/include_entities skip_satus/], returns => 'ArrayRef[User]', description => <<'', Returns an array of users who can contribute to the specified account.

);

twitter_api_method direct_messages => ( description => <<'', Returns a list of the 20 most recent direct messages sent to the authenticating user including detailed information about the sending and recipient users.

    path     => 'direct_messages',
    method   => 'GET',
    params   => [qw/since_id max_id count page include_entities/],
    required => [qw/include_entities/],
    returns  => 'ArrayRef[DirectMessage]',
);

twitter_api_method sent_direct_messages => ( description => <<'', Returns a list of the 20 most recent direct messages sent by the authenticating user including detailed information about the sending and recipient users.

    path     => 'direct_messages/sent',
    method   => 'GET',
    params   => [qw/since_id max_id page count include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'ArrayRef[DirectMessage]',
);

twitter_api_method new_direct_message => ( description => <<'', Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters. Returns the sent message when successful. In order to support numeric screen names, the screen_name or user_id parameters may be used instead of user.

    path     => 'direct_messages/new',
    method   => 'POST',
    params   => [qw/user text screen_name user_id include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/user text/],
    returns  => 'DirectMessage',
);

twitter_api_method destroy_direct_message => ( description => <<'', Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.

    path     => 'direct_messages/destroy/:id',
    method   => 'POST',
    params   => [qw/id include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'DirectMessage',
);

twitter_api_method show_friendship => ( description => <<'', Returns detailed information about the relationship between two users.

    aliases  => [qw/show_relationship/],
    path     => 'friendships/show',
    method   => 'GET',
    params   => [qw/source_id source_screen_name target_id target_id_name/],
    required => [qw/id/],
    returns  => 'Relationship',
);

twitter_api_method create_friend => ( description => <<'', Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user when successful. Returns a string describing the failure condition when unsuccessful.

    aliases  => [qw/follow_new/],
    path     => 'friendships/create/:id',
    method   => 'POST',
    params   => [qw/id user_id screen_name follow include_entities/],
    booleans => [qw/include_entities follow/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method destroy_friend => ( description => <<'', Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns the un-friended user when successful. Returns a string describing the failure condition when unsuccessful.

    aliases  => [qw/unfollow/],
    path     => 'friendships/destroy/:id',
    method   => 'POST',
    params   => [qw/id user_id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method friendship_exists => ( aliases => [qw/relationship_exists follows/], # Net::Twitter description => <<'EOT', Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false.

Use of user_a and user_b is deprecated. It has been preserved for backwards compatibility, and is used for the two-argument positional form:

    $nt->friendship_exists($user_a, $user_b);

Instead, you should use one of the named argument forms:

    $nt->friendship_exists({ user_id_a => $id1, user_id_b => $id2 });
    $nt->friendship_exists({ screen_name_a => $name1, screen_name_b => $name2 });

Consider using show_friendship instead. EOT

    path     => 'friendships/exists',
    method   => 'GET',
    params   => [qw/user_id_a user_id_b screen_name_a screen_name_b user_a user_b/],
    required => [qw/user_a user_b/],
    returns  => 'Bool',
);

twitter_api_method no_retweet_ids => ( description => <<'', Returns an ARRAY ref of user IDs for which the authenticating user does not want to receive retweets.

    path     => 'friendships/no_retweet_ids',
    method   => 'GET',
    params   => [],
    required => [],
    returns  => 'ArrayRef[UserIDs]',
);

twitter_api_method friends_ids => ( description => <<'EOT', Returns a reference to an array of numeric IDs for every user followed by the specified user. The order of the IDs is reverse chronological.

Use the optional cursor parameter to retrieve IDs in pages of 5000. When the cursor parameter is used, the return value is a reference to a hash with keys previous_cursor, next_cursor, and ids. The value of ids is a reference to an array of IDS of the user's friends. Set the optional cursor parameter to -1 to get the first page of IDs. Set it to the prior return's value of previous_cursor or next_cursor to page forward or backwards. When there are no prior pages, the value of previous_cursor will be 0. When there are no subsequent pages, the value of next_cursor will be 0. EOT

    aliases  => [qw/following_ids/],
    path     => 'friends/ids/:id',
    method   => 'GET',
    params   => [qw/id user_id screen_name cursor/],
    required => [qw/id/],
    returns  => 'HashRef|ArrayRef[Int]',
);

twitter_api_method followers_ids => ( description => <<'EOT', Returns a reference to an array of numeric IDs for every user following the specified user. The order of the IDs may change from call to call. To obtain the screen names, pass the arrayref to "lookup_users".

Use the optional cursor parameter to retrieve IDs in pages of 5000. When the cursor parameter is used, the return value is a reference to a hash with keys previous_cursor, next_cursor, and ids. The value of ids is a reference to an array of IDS of the user's followers. Set the optional cursor parameter to -1 to get the first page of IDs. Set it to the prior return's value of previous_cursor or next_cursor to page forward or backwards. When there are no prior pages, the value of previous_cursor will be 0. When there are no subsequent pages, the value of next_cursor will be 0. EOT

    path     => 'followers/ids/:id',
    method   => 'GET',
    params   => [qw/id user_id screen_name cursor/],
    required => [qw/id/],
    returns  => 'HashRef|ArrayRef[Int]',
);

twitter_api_method verify_credentials => ( description => <<'', Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.

    path     => 'account/verify_credentials',
    method   => 'GET',
    params   => [qw/include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'ExtendedUser',
);

twitter_api_method end_session => ( description => <<'', Ends the session of the authenticating user, returning a null cookie. Use this method to sign users out of client-facing applications like widgets.

    path     => 'account/end_session',
    method   => 'POST',
    params   => [qw//],
    required => [qw//],
    returns  => 'Error', # HTTP Status: 200, error content. Silly!
);

twitter_api_method update_location => ( description => <<'', This method has been deprecated in favor of the update_profile method. Its URL will continue to work, but please consider migrating to the newer and more comprehensive method of updating profile attributes.

    deprecated  => 1,
    path     => 'account/update_location',
    method   => 'POST',
    params   => [qw/location/],
    required => [qw/location/],
    returns  => 'BasicUser',
);

twitter_api_method update_delivery_device => ( description => <<'', Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable IM or SMS updates.

    path     => 'account/update_delivery_device',
    method   => 'POST',
    params   => [qw/device/],
    required => [qw/device/],
    returns  => 'BasicUser',
);

twitter_api_method update_profile_colors => ( description => <<'', Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. These values are also returned in the /users/show API method.

    path     => 'account/update_profile_colors',
    method   => 'POST',
    params   => [qw/
        profile_background_color
        profile_text_color
        profile_link_color
        profile_sidebar_fill_color
        profile_sidebar_border_color
    /],
    required => [qw//],
    returns  => 'ExtendedUser',
);

twitter_api_method update_profile_image => ( description => <<'EOT', Updates the authenticating user's profile image. The image parameter is an arrayref with the following interpretation:

  [ $file ]
  [ $file, $filename ]
  [ $file, $filename, Content_Type => $mime_type ]
  [ undef, $filename, Content_Type => $mime_type, Content => $raw_image_data ]

The first value of the array ($file) is the name of a file to open. The second value ($filename) is the name given to Twitter for the file. If $filename is not provided, the basename portion of $file is used. If $mime_type is not provided, it will be provided automatically using LWP::MediaTypes::guess_media_type().

$raw_image_data can be provided, rather than opening a file, by passing undef as the first array value. EOT

    path     => 'account/update_profile_image',
    method   => 'POST',
    params   => [qw/image/],
    required => [qw/image/],
    returns  => 'ExtendedUser',
);

twitter_api_method update_profile_background_image => ( description => <<'', Updates the authenticating user's profile background image. The image parameter must be an arrayref with the same interpretation as the image parameter in the update_profile_image method. The use parameter allows you to specify whether to use the uploaded profile background or not. See that method's documentation for details.

    path     => 'account/update_profile_background_image',
    method   => 'POST',
    params   => [qw/image use/],
    required => [qw/image/],
    booleans => [qw/use/],
    returns  => 'ExtendedUser',
);

twitter_api_method rate_limit_status => ( description => <<'EOT', Returns the remaining number of API requests available to the authenticated user before the API limit is reached for the current hour.

Use ->rate_limit_status({ authenticate => 0 }) to force an unauthenticated call, which will return the status for the IP address rather than the authenticated user. (Note: for a web application, this is the server's IP address.) EOT

    path     => 'account/rate_limit_status',
    method   => 'GET',
    params   => [qw//],
    required => [qw//],
    returns  => 'RateLimitStatus',
);

twitter_api_method update_profile => ( description => <<'', Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated; to only update the "name" attribute, for example, only include that parameter in your request.

    path     => 'account/update_profile',
    method   => 'POST',
    params   => [qw/ name email url location description include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'ExtendedUser',
);

twitter_api_method favorites => ( description => <<'', Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter.

    path     => 'favorites/:id',
    method   => 'GET',
    params   => [qw/id page include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'ArrayRef[Status]',
);

twitter_api_method create_favorite => ( description => <<'', Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.

    path     => 'favorites/create/:id',
    method   => 'POST',
    params   => [qw/id include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'Status',
);

twitter_api_method destroy_favorite => ( description => <<'', Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status.

    path     => 'favorites/destroy/:id',
    method   => 'POST',
    params   => [qw/id include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'Status',
);

twitter_api_method enable_notifications => ( description => <<'', Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.

    path     => 'notifications/follow/:id',
    method   => 'POST',
    params   => [qw/id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method disable_notifications => ( description => <<'', Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.

    path     => 'notifications/leave/:id',
    method   => 'POST',
    params   => [qw/id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method create_block => ( description => <<'', Blocks the user specified in the ID parameter as the authenticating user. Returns the blocked user when successful. You can find out more about blocking in the Twitter Support Knowledge Base.

    path     => 'blocks/create/:id',
    method   => 'POST',
    params   => [qw/id user_id screen_name include_entities/],
    booleans => [qw/include_entities/],    
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method destroy_block => ( description => <<'', Un-blocks the user specified in the ID parameter as the authenticating user. Returns the un-blocked user when successful.

    path     => 'blocks/destroy/:id',
    method   => 'POST',
    params   => [qw/id user_id screen_name/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method block_exists => ( description => <<'', Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with HTTP 404 response code otherwise.

    path     => 'blocks/exists/:id',
    method   => 'GET',
    params   => [qw/id user_id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'BasicUser',
);

twitter_api_method blocking => ( description => <<'', Returns an array of user objects that the authenticating user is blocking.

    path     => 'blocks/blocking',
    method   => 'GET',
    params   => [qw/page include_entities/],
    booleans => [qw/include_entities/],
    required => [qw//],
    returns  => 'ArrayRef[BasicUser]',
);

twitter_api_method blocking_ids => ( description => <<'', Returns an array of numeric user ids the authenticating user is blocking.

    path     => 'blocks/blocking/ids',
    method   => 'GET',
    params   => [qw//],
    required => [qw//],
    returns  => 'ArrayRef[Int]',
);

twitter_api_method test => ( description => <<'', Returns the string "ok" status code.

    path     => 'help/test',
    method   => 'GET',
    params   => [qw//],
    required => [qw//],
    returns  => 'Str',
);

twitter_api_method downtime_schedule => ( description => <<'', Returns the same text displayed on http://twitter.com/home when a maintenance window is scheduled.

    deprecated => 1,
    path     => 'help/downtime_schedule',
    method   => 'GET',
    params   => [qw//],
    required => [qw//],
    returns  => 'Str',
);

twitter_api_method get_configuration => ( path => 'help/configuration', method => 'GET', params => [], required => [], returns => 'HashRef', description => <<'EOT', Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.

It is recommended applications request this endpoint when they are loaded, but no more than once a day. EOT

);

twitter_api_method get_languages => ( path => 'help/languages', method => 'GET', params => [], required => [], returns => 'ArrayRef[Lanugage]', description => <<'', Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.

);

twitter_api_method saved_searches => ( description => <<'', Returns the authenticated user's saved search queries.

    path     => 'saved_searches',
    method   => 'GET',
    params   => [],
    required => [],
    returns  => 'ArrayRef[SavedSearch]',
);

twitter_api_method show_saved_search => ( description => <<'', Retrieve the data for a saved search, by id, owned by the authenticating user.

    path     => 'saved_searches/show/:id',
    method   => 'GET',
    params   => [qw/id/],
    required => [qw/id/],
    returns  => 'SavedSearch',
);

twitter_api_method create_saved_search => ( description => <<'', Creates a saved search for the authenticated user.

    path     => 'saved_searches/create',
    method   => 'POST',
    params   => [qw/query/],
    required => [qw/query/],
    returns  => 'SavedSearch',
);

twitter_api_method destroy_saved_search => ( description => <<'', Destroys a saved search. The search, specified by id, must be owned by the authenticating user.

    path     => 'saved_searches/destroy/:id',
    method   => 'POST',
    params   => [qw/id/],
    required => [qw/id/],
    returns  => 'SavedSearch',
);

twitter_api_method report_spam => ( description => <<'', The user specified in the id is blocked by the authenticated user and reported as a spammer.

    path     => 'report_spam',
    method   => 'POST',
    params   => [qw/id user_id screen_name include_entities/],
    booleans => [qw/include_entities/],
    required => [qw/id/],
    returns  => 'User',
);

twitter_api_method users_search => ( aliases => [qw/find_people search_users/], path => 'users/search', method => 'GET', params => [qw/q per_page page include_entities/], booleans => [qw/include_entities/], required => [qw/q/], returns => 'ArrayRef[Users]', description => <<'', Run a search for users similar to Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API (about being listed in the People Search). It is only possible to retrieve the first 1000 matches from this API.

);

twitter_api_method trends_available => ( path => 'trends/available', method => 'GET', params => [qw/lat long/], required => [], authenticate => 0, returns => 'ArrayRef[Location]', description => <<EOT, Returns the locations with trending topic information. The response is an array of "locations" that encode the location's WOEID (a Yahoo! Where On Earth ID http://developer.yahoo.com/geo/geoplanet/) and some other human-readable information such as a the location's canonical name and country.

When the optional lat and long parameters are passed, the available trend locations are sorted by distance from that location, nearest to farthest.

Use the WOEID returned in the location object to query trends for a specific location. EOT );

twitter_api_method trends_location => ( path => 'trends/:woeid', method => 'GET', params => [qw/woeid/], required => [qw/woeid/], returns => 'ArrayRef[Trend]', authenticate => 0, description => <<'', Returns the top 10 trending topics for a specific location. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes. Global trends information is also available from this API by using a WOEID of 1.

);

twitter_api_method trends => ( description => <<'', Returns the top ten queries that are currently trending on Twitter. The response includes the time of the request, the name of each trending topic, and the url to the Twitter Search results page for that topic.

    path     => 'trends',
    method   => 'GET',
    params   => [qw//],
    required => [qw//],
    authenticate => 0,
    returns  => 'ArrayRef[Query]',
    deprecated => 1,
);

my $trends_deprecation_warned = 0; around trends => sub { my $orig = shift; my $self = shift;

    my $args = ref $_[-1] eq ref {} ? pop : {};

    $trends_deprecation_warned ||= do {
        local $Carp::CarpLevel = 3;
        carp "The 'trends' API method has been deprecated; instead, use trends_location({ woeid => 1 })";
        1;
    };

    $args->{woeid} = 1;

    return $self->trends_location(@_, $args);
};

twitter_api_method trends_current => ( description => <<'', Returns the current top ten trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on Twitter Search results page for that topic.

    path     => 'trends/current',
    method   => 'GET',
    params   => [qw/exclude/],
    required => [qw//],
    authenticate => 0,
    returns  => 'HashRef',
);

twitter_api_method trends_daily => ( description => <<'', Returns the top 20 trending topics for each hour in a given day.

    path     => 'trends/daily',
    method   => 'GET',
    params   => [qw/date exclude/],
    required => [qw//],
    authenticate => 0,
    returns  => 'HashRef',
);

twitter_api_method trends_weekly => ( description => <<'', Returns the top 30 trending topics for each day in a given week.

    path     => 'trends/weekly',
    method   => 'GET',
    params   => [qw/date exclude/],
    required => [qw//],
    authenticate => 0,
    returns  => 'HashRef',
);

twitter_api_method reverse_geocode => ( path => 'geo/reverse_geocode', method => 'GET', params => [qw/lat long accuracy granularity max_results/], required => [qw/lat long/], returns => 'HashRef', description => <<'EOT',

Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update.

There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.

lat

Required. The latitude to query about. Valid ranges are -90.0 to +90.0 (North is positive) inclusive.

long

Required. The longitude to query about. Valid ranges are -180.0 to +180.0 (East is positive) inclusive.

accuracy

Optional. A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).

granularity

Optional. The minimal granularity of data to return. If this is not passed in, then neighborhood is assumed. city can also be passed.

max_results

Optional. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.

EOT );

twitter_api_method geo_id => ( path => 'geo/id/:id', method => 'GET', params => [qw/id/], required => [qw/id/], returns => 'HashRef', description => <<'EOT', Returns details of a place returned from the reverse_geocode method. EOT );

twitter_api_method geo_search => ( path => 'geo/search', method => 'GET', params => [qw/ lat long query ip granularity accuracy max_results contained_within attribute:street_address callback /], required => [], returns => 'HashRef', description => <<'EOT', Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.

Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location with a call to statuses/update.

This is the recommended method to use find places that can be attached to statuses/update. Unlike geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user. EOT

);

twitter_api_method similar_places => ( path => 'geo/similar_places', method => 'GET', params => [qw/lat long name contained_within attribute:street_address callback/], required => [qw/lat long name/], returns => 'HashRef', description => <<'EOT', Locates places near the given coordinates which are similar in name.

Conceptually you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to add_place to create a new one.

The token contained in the response is the token needed to be able to create a new place. EOT

);

twitter_api_method add_place => ( path => 'geo/place', method => 'POST', params => [qw/name contained_within token lat long attribute:street_address callback/], required => [qw/name contained_within token lat long/], returns => 'Place', description => <<'EOT', Creates a new place object at the given latitude and longitude.

Before creating a place you need to query similar_places with the latitude, longitude and name of the place you wish to create. The query will return an array of places which are similar to the one you wish to create, and a token. If the place you wish to create isn't in the returned array you can use the token with this method to create a new one. EOT

);

twitter_api_method lookup_users => ( path => 'users/lookup', method => 'GET', params => [qw/user_id screen_name include_entities/], booleans => [qw/include_entities/], required => [], returns => 'ArrayRef[User]', description => <<'EOT' Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two. The author's most recent status (if the authenticating user has permission) will be returned inline. This method is rate limited to 1000 calls per hour.

This method will accept user IDs or screen names as either a comma delimited string, or as an ARRAY ref. It will also accept arguments in the normal HASHREF form or as a simple list of named arguments. I.e., any of the following forms are acceptable:

    $nt->lookup_users({ user_id => '1234,6543,3333' });
    $nt->lookup_users(user_id => '1234,6543,3333');
    $nt->lookup_users({ user_id => [ 1234, 6543, 3333 ] });
    $nt->lookup_users({ screen_name => 'fred,barney,wilma' });
    $nt->lookup_users(screen_name => ['fred', 'barney', 'wilma']);

    $nt->lookup_users(
        screen_name => ['fred', 'barney' ],
        user_id     => '4321,6789',
    );

EOT );

twitter_api_method retweeted_by => ( path => 'statuses/:id/retweeted_by', method => 'GET', params => [qw/id count page trim_user include_entities/], booleans => [qw/include_entities trim_user/], required => [qw/id/], returns => 'ArrayRef[User]', description => <<'' Returns up to 100 users who retweeted the status identified by id.

);

twitter_api_method retweeted_by_ids => ( path => 'statuses/:id/retweeted_by/ids', method => 'GET', params => [qw/id count page trim_user include_entities/], booleans => [qw/include_entities trim_user/], required => [qw/id/], returns => 'ArrayRef[User]', description => <<'' Returns the IDs of up to 100 users who retweeted the status identified by id.

);

twitter_api_method friendships_incoming => ( path => 'friendships/incoming', method => 'GET', params => [qw/cursor/], required => [qw/cursor/], returns => 'HashRef', description => <<'', Returns an HASH ref with an array of numeric IDs in the ids element for every user who has a pending request to follow the authenticating user.

);

twitter_api_method friendships_outgoing => ( path => 'friendships/outgoing', method => 'GET', params => [qw/cursor/], required => [qw/cursor/], returns => 'HashRef', description => <<'', Returns an HASH ref with an array of numeric IDs in the ids element for every protected user for whom the authenticating user has a pending follow request.

);

# new in 3.17001 2010-10-19

twitter_api_method account_totals => ( path => 'account/totals', method => 'GET', params => [], required => [], returns => 'HashRef', description => <<'' Returns the current count of friends, followers, updates (statuses) and favorites of the authenticating user.

);

twitter_api_method account_settings => ( path => 'account/settings', method => 'GET', params => [], required => [], returns => 'HashRef', description => <<'' Returns the current trend, geo and sleep time information for the authenticating user.

);

twitter_api_method suggestion_categories => ( path => 'users/suggestions', method => 'GET', params => [], required => [], returns => 'ArrayRef', description => <<'' Returns the list of suggested user categories. The category slug can be used in the user_suggestions API method get the users in that category . Does not require authentication.

);

twitter_api_method user_suggestions => ( aliases => [qw/follow_suggestions/], path => 'users/suggestions/:category/members', method => 'GET', params => [qw/category lang/], required => [qw/category/], returns => 'ArrayRef', description => <<'' Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user. Currently supported values for optional parameter lang are en, fr, de, es, it. Does not require authentication.

);

twitter_api_method show_direct_message => ( path => 'direct_messages/show/:id', method => 'GET', params => [qw/id include_entities/], booleans => [qw/include_entities/], required => [qw/id/], returns => 'HashRef', description => <<'' Returns a single direct message, specified by an id parameter. Like the direct_messages request, this method will include the user objects of the sender and recipient. Requires authentication.

);

twitter_api_method retweeted_to_user => ( path => 'statuses/retweeted_to_user', method => 'GET', params => [qw/id user_id screen_name/], required => [qw/id/], returns => 'ArrayRef', description => <<'' Returns the 20 most recent retweets posted by users the specified user follows. The user is specified using the user_id or screen_name parameters. This method is identical to retweeted_to_me except you can choose the user to view. Does not require authentication, unless the user is protected.

);

twitter_api_method retweeted_by_user => ( path => 'statuses/retweeted_by_user', method => 'GET', params => [qw/id user_id screen_name/], required => [qw/id/], returns => 'ArrayRef', description => <<'' Returns the 20 most recent retweets posted by the specified user. The user is specified using the user_id or screen_name parameters. This method is identical to retweeted_by_me except you can choose the user to view. Does not require authentication, unless the user is protected.

);

twitter_api_method lookup_friendships => ( path => 'friendships/lookup', method => 'GET', params => [qw/user_id screen_name/], required => [], returns => 'ArrayRef', description => <<'' Returns the relationship of the authenticating user to the comma separated list or ARRAY ref of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none. Requires authentication.

);

twitter_api_method update_friendship => ( path => 'friendships/update', method => 'POST', params => [qw/id user_id screen_name device retweets/], required => [qw/id/], booleans => [qw/device retweets/], returns => 'HashRef', description => <<'' Allows you enable or disable retweets and device notifications from the specified user. All other values are assumed to be false. Requires authentication.

);

twitter_api_method related_results => ( path => 'related_results/show/:id', method => 'GET', params => [qw/id/], required => [qw/id/], returns => 'ArrayRef[Status]', description => <<'' If available, returns an array of replies and mentions related to the specified status. There is no guarantee there will be any replies or mentions in the response. This method is only available to users who have access to #newtwitter. Requires authentication.

);

### Lists ###

twitter_api_method all_subscriptions => ( path => 'lists/all', method => 'GET', params => [qw/user_id screen_name count cursor/], required => [], returns => 'ArrayRef[List]', aliases => [qw/all_lists list_subscriptions/], description => <<'', Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used.

);

twitter_api_method list_statuses => ( path => 'lists/statuses', method => 'GET', params => [qw/ list_id slug owner_screen_name owner_id since_id max_id per_page page include_entities include_rts /], required => [], booleans => [qw/include_entities include_rts/], returns => 'ArrayRef[Status]', description => <<'', Returns tweet timeline for members of the specified list. Historically, retweets were not available in list timeline responses but you can now use the include_rts=true parameter to additionally receive retweet objects.

);

twitter_api_method delete_list_member => ( path => 'lists/members/destroy', method => 'POST', params => [qw/list_id slug user_id screen_name owner_screen_name owner_id/], required => [], returns => 'User', aliases => [qw/remove_list_member/], description => <<'', Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list.

);

twitter_api_method list_memberships => ( path => 'lists/memberships', method => 'GET', params => [qw/user_id screen_name cursor filter_to_owned_lists/], required => [], booleans => [qw/filter_to_owned_lists/], returns => 'Hashref', description => <<'', Returns the lists the specified user has been added to. If user_id or screen_name are not provided the memberships for the authenticating user are returned.

);

twitter_api_method list_subscribers => ( path => 'lists/subscribers', method => 'GET', params => [qw/list_id slug owner_screen_name owner_id cursor include_entities skip_status/], required => [], booleans => [qw/include_entities skip_status/], returns => 'Hashref', description => <<'', Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.

);

twitter_api_method subscribe_list => ( path => 'lists/subscribers/create', method => 'POST', params => [qw/owner_screen_name owner_id list_id slug/], required => [], returns => 'List', description => <<'', Subscribes the authenticated user to the specified list.

);

twitter_api_method is_list_subscriber => ( path => 'lists/subscribers/show', method => 'GET', params => [qw/ owner_screen_name owner_id list_id slug user_id screen_name include_entities skip_status /], required => [], booleans => [qw/include_entities skip_status/], returns => 'Maybe[User]', aliases => [qw/is_subscribed_list/], description => <<'', Check if the specified user is a subscriber of the specified list. Returns the user or undef.

);

around [qw/is_list_subscriber is_subscribed_list/] => sub { my $orig = shift; my $self = shift;

    $self->_user_or_undef($orig, 'subscriber', @_);
};

twitter_api_method unsubscribe_list => ( path => 'lists/subscribers/destroy', method => 'POST', params => [qw/list_id slug owner_screen_name owner_id/], required => [], returns => 'List', description => <<'', Unsubscribes the authenticated user from the specified list.

);

twitter_api_method members_create_all => ( path => 'lists/members/create_all', method => 'POST', params => [qw/list_id slug owner_screen_name owner_id/], required => [], returns => 'List', aliases => [qw/add_list_members/], description => <<'', Adds multiple members to a list, by specifying a reference to an array or a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members, and you are limited to adding up to 100 members to a list at a time with this method.

);

twitter_api_method members_destroy_all => ( path => 'lists/members/destroy_all', method => 'POST', params => [qw/list_id slug user_id screen_name owner_screen_name owner_id/], required => [], returns => 'List', aliases => [qw/remove_list_members/], description => <<'EOT', Removes multiple members from a list, by specifying a reference to an array of member ids or screen names, or a string of comma separated user ids or screen names. The authenticated user must own the list to be able to remove members from it. Note that lists can't have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method.

Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.

EOT );

twitter_api_method is_list_member => ( path => 'lists/members/show', method => 'GET', params => [qw/ owner_screen_name owner_id list_id slug user_id screen_name include_entities skip_status /], required => [], booleans => [qw/include_entities skip_status/], returns => 'Maybe[User]', description => <<'', Check if the specified user is a member of the specified list. Returns the user or undef.

);

around is_list_member => sub { my $orig = shift; my $self = shift;

    $self->_user_or_undef($orig, 'member', @_);
};

twitter_api_method list_members => ( path => 'lists/members', method => 'GET', params => [qw/ list_id slug owner_screen_name owner_id cursor include_entities skip_status /], required => [], booleans => [qw/include_entities skip_status/], returns => 'Hashref', description => <<'', Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list.

);

twitter_api_method add_list_member => ( path => 'lists/members/create', method => 'POST', params => [qw/list_id slug user_id screen_name owner_screen_name owner_id/], required => [], returns => 'User', description => <<'', Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members.

);

twitter_api_method delete_list => ( path => 'lists/destroy', method => 'POST', params => [qw/owner_screen_name owner_id list_id slug/], required => [], returns => 'List', description => <<'', Deletes the specified list. The authenticated user must own the list to be able to destroy it.

);

twitter_api_method update_list => ( path => 'lists/update', method => 'POST', params => [qw/list_id slug name mode description owner_screen_name owner_id/], required => [], returns => 'List', description => <<'', Updates the specified list. The authenticated user must own the list to be able to update it.

);

twitter_api_method create_list => ( path => 'lists/create', method => 'POST', params => [qw/list_id slug name mode description owner_screen_name owner_id/], required => [], returns => 'List', description => <<'', Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account.

);

twitter_api_method get_lists => ( path => 'lists', method => 'GET', params => [qw/user_id screen_name cursor/], required => [], returns => 'Hashref', aliases => [qw/list_lists/], description => <<'', Returns the lists of the specified (or authenticated) user. Private lists will be included if the authenticated user is the same as the user whose lists are being returned.

);

twitter_api_method get_list => ( path => 'lists/show', method => 'GET', params => [qw/list_id slug owner_screen_name owner_id/], required => [], returns => 'List', description => <<'', Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list.

);

twitter_api_method subscriptions => ( path => 'lists/subscriptions', method => 'GET', params => [qw/user_id screen_name count cursor/], required => [], returns => 'ArrayRef[List]', aliases => [], description => <<'', Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists.

);

### Legal ###

twitter_api_method get_privacy_policy => ( path => 'legal/privacy', method => 'GET', params => [], required => [], returns => 'HashRef', description => <<'', Returns Twitter's privacy policy.

);

twitter_api_method get_tos => ( path => 'legal/tos', method => 'GET', params => [], required => [], returns => 'HashRef', description => <<'', Returns the Twitter Terms of Service. These are not the same as the Developer Rules of the Road.

);

1;

__END__

NAME ^

Net::Twitter::Role::API::REST - A definition of the Twitter REST API as a Moose role

SYNOPSIS ^

  package My::Twitter;
  use Moose;
  with 'Net::Twitter::API::REST';

DESCRIPTION ^

Net::Twitter::Role::API::REST provides definitions for all the Twitter REST API methods. Applying this role to any class provides methods for all of the Twitter REST API methods.

AUTHOR ^

Marc Mims <marc@questright.com>

LICENSE ^

Copyright (c) 2009 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.

syntax highlighting: