1Net::Twitter::Role::APIU:s:eRrESCTo(n3t)ributed Perl DocNuemte:n:tTawtiitotner::Role::API::REST(3)
2
3
4
5 status
6 Required. The text of your status update. URL encode as necessary.
7 Statuses over 140 characters will cause a 403 error to be returned
8 from the API.
9
10 in_reply_to_status_id
11 Optional. The ID of an existing status that the update is in reply
12 to. o Note: This parameter will be ignored unless the author of
13 the tweet this parameter references is mentioned within the status
14 text. Therefore, you must include @username, where username is the
15 author of the referenced tweet, within the update.
16
17 lat Optional. The location's latitude that this tweet refers to. The
18 valid ranges for latitude is -90.0 to +90.0 (North is positive)
19 inclusive. This parameter will be ignored if outside that range,
20 if it is not a number, if geo_enabled is disabled, or if there not
21 a corresponding long parameter with this tweet.
22
23 long
24 Optional. The location's longitude that this tweet refers to. The
25 valid ranges for longitude is -180.0 to +180.0 (East is positive)
26 inclusive. This parameter will be ignored if outside that range,
27 if it is not a number, if geo_enabled is disabled, or if there not
28 a corresponding lat parameter with this tweet.
29
30 place_id
31 Optional. The place to attach to this status update. Valid
32 place_ids can be found by querying "reverse_geocode".
33
34 display_coordinates
35 Optional. By default, geo-tweets will have their coordinates
36 exposed in the status object (to remain backwards compatible with
37 existing API applications). To turn off the display of the precise
38 latitude and longitude (but keep the contextual location
39 information), pass "display_coordinates =" 0> on the status update.
40
41 EOT
42
43 );
44
45 twitter_api_method destroy_status => (
46 description => <<'', Destroys the status specified by the required
47 ID parameter. The authenticating user must be the author of the
48 specified status.
49
50 path => 'statuses/destroy/:id',
51 method => 'POST',
52 params => [qw/id trim_user include_entities/],
53 booleans => [qw/trim_user include_entities/],
54 required => [qw/id/],
55 returns => 'Status',
56 );
57
58 twitter_api_method friends => (
59 deprecated => 1,
60 description => <<'EOT', This method has been deprecated. Twitter
61 intends to stop support for it on May 14, 2012. Use "friends_ids" and
62 "lookup_users" instead.
63
64 Returns a reference to an array of the user's friends. If "id",
65 "user_id", or "screen_name" is not specified, the friends of the
66 authenticating user are returned. The returned users are ordered from
67 most recently followed to least recently followed.
68
69 Use the optional "cursor" parameter to retrieve users in pages of 100.
70 When the "cursor" parameter is used, the return value is a reference to
71 a hash with keys "previous_cursor", "next_cursor", and "users". The
72 value of "users" is a reference to an array of the user's friends. The
73 result set isn't guaranteed to be 100 every time as suspended users
74 will be filtered out. Set the optional "cursor" parameter to -1 to get
75 the first page of users. Set it to the prior return's value of
76 "previous_cursor" or "next_cursor" to page forward or backwards. When
77 there are no prior pages, the value of "previous_cursor" will be 0.
78 When there are no subsequent pages, the value of "next_cursor" will be
79 0. EOT
80
81 aliases => [qw/following/],
82 path => 'statuses/friends/:id',
83 method => 'GET',
84 params => [qw/id user_id screen_name cursor include_entities/],
85 booleans => [qw/include_entities/],
86 required => [qw//],
87 returns => 'Hashref|ArrayRef[User]',
88 );
89
90 twitter_api_method followers => (
91 deprecated => 1,
92 description => <<'EOT', This method has been deprecated. Twitter
93 intends to stop support for it on May 14, 2012. Use "friends_ids" and
94 "lookup_users" instead.
95
96 Returns a reference to an array of the user's followers. If "id",
97 "user_id", or "screen_name" is not specified, the followers of the
98 authenticating user are returned. The returned users are ordered from
99 most recently followed to least recently followed.
100
101 Use the optional "cursor" parameter to retrieve users in pages of 100.
102 When the "cursor" parameter is used, the return value is a reference to
103 a hash with keys "previous_cursor", "next_cursor", and "users". The
104 value of "users" is a reference to an array of the user's friends. The
105 result set isn't guaranteed to be 100 every time as suspended users
106 will be filtered out. Set the optional "cursor" parameter to -1 to get
107 the first page of users. Set it to the prior return's value of
108 "previous_cursor" or "next_cursor" to page forward or backwards. When
109 there are no prior pages, the value of "previous_cursor" will be 0.
110 When there are no subsequent pages, the value of "next_cursor" will be
111 0. EOT
112
113 path => 'statuses/followers/:id',
114 method => 'GET',
115 params => [qw/id user_id screen_name cursor include_entities/],
116 booleans => [qw/include_entities/],
117 required => [qw//],
118 returns => 'HashRef|ArrayRef[User]',
119 );
120
121 twitter_api_method show_user => (
122 description => <<'', Returns extended information of a given user,
123 specified by ID or screen name as per the required id parameter. This
124 information includes design settings, so third party developers can
125 theme their widgets according to a given user's preferences. You must
126 be properly authenticated to request the page of a protected user.
127
128 path => 'users/show/:id',
129 method => 'GET',
130 params => [qw/id screen_name include_entities/],
131 booleans => [qw/include_entities/],
132 required => [qw/id/],
133 returns => 'ExtendedUser',
134 );
135
136 twitter_api_method contributees => (
137 path => 'users/contributees',
138 method => 'GET',
139 params => [qw/user_id screen_name include_entities
140 skip_satus/],
141 required => [],
142 booleans => [qw/include_entities skip_satus/],
143 returns => 'ArrayRef[User]',
144 description => <<'', Returns an array of users that the specified
145 user can contribute to.
146
147 );
148
149 twitter_api_method contributors => (
150 path => 'users/contributors',
151 method => 'GET',
152 params => [qw/user_id screen_name include_entities
153 skip_satus/],
154 required => [],
155 booleans => [qw/include_entities skip_satus/],
156 returns => 'ArrayRef[User]',
157 description => <<'', Returns an array of users who can contribute
158 to the specified account.
159
160 );
161
162 twitter_api_method direct_messages => (
163 description => <<'', Returns a list of the 20 most recent direct
164 messages sent to the authenticating user including detailed information
165 about the sending and recipient users.
166
167 path => 'direct_messages',
168 method => 'GET',
169 params => [qw/since_id max_id count page include_entities/],
170 required => [qw/include_entities/],
171 returns => 'ArrayRef[DirectMessage]',
172 );
173
174 twitter_api_method sent_direct_messages => (
175 description => <<'', Returns a list of the 20 most recent direct
176 messages sent by the authenticating user including detailed information
177 about the sending and recipient users.
178
179 path => 'direct_messages/sent',
180 method => 'GET',
181 params => [qw/since_id max_id page count include_entities/],
182 booleans => [qw/include_entities/],
183 required => [qw//],
184 returns => 'ArrayRef[DirectMessage]',
185 );
186
187 twitter_api_method new_direct_message => (
188 description => <<'', Sends a new direct message to the specified
189 user from the authenticating user. Requires both the user and text
190 parameters. Returns the sent message when successful. In order to
191 support numeric screen names, the "screen_name" or "user_id" parameters
192 may be used instead of "user".
193
194 path => 'direct_messages/new',
195 method => 'POST',
196 params => [qw/user text screen_name user_id include_entities/],
197 booleans => [qw/include_entities/],
198 required => [qw/user text/],
199 returns => 'DirectMessage',
200 );
201
202 twitter_api_method destroy_direct_message => (
203 description => <<'', Destroys the direct message specified in the
204 required ID parameter. The authenticating user must be the recipient
205 of the specified direct message.
206
207 path => 'direct_messages/destroy/:id',
208 method => 'POST',
209 params => [qw/id include_entities/],
210 booleans => [qw/include_entities/],
211 required => [qw/id/],
212 returns => 'DirectMessage',
213 );
214
215 twitter_api_method show_friendship => (
216 description => <<'', Returns detailed information about the
217 relationship between two users.
218
219 aliases => [qw/show_relationship/],
220 path => 'friendships/show',
221 method => 'GET',
222 params => [qw/source_id source_screen_name target_id target_id_name/],
223 required => [qw/id/],
224 returns => 'Relationship',
225 );
226
227 twitter_api_method create_friend => (
228 description => <<'', Befriends the user specified in the ID
229 parameter as the authenticating user. Returns the befriended user when
230 successful. Returns a string describing the failure condition when
231 unsuccessful.
232
233 aliases => [qw/follow_new/],
234 path => 'friendships/create/:id',
235 method => 'POST',
236 params => [qw/id user_id screen_name follow include_entities/],
237 booleans => [qw/include_entities follow/],
238 required => [qw/id/],
239 returns => 'BasicUser',
240 );
241
242 twitter_api_method destroy_friend => (
243 description => <<'', Discontinues friendship with the user
244 specified in the ID parameter as the authenticating user. Returns the
245 un-friended user when successful. Returns a string describing the
246 failure condition when unsuccessful.
247
248 aliases => [qw/unfollow/],
249 path => 'friendships/destroy/:id',
250 method => 'POST',
251 params => [qw/id user_id screen_name include_entities/],
252 booleans => [qw/include_entities/],
253 required => [qw/id/],
254 returns => 'BasicUser',
255 );
256
257 twitter_api_method friendship_exists => (
258 aliases => [qw/relationship_exists follows/], # Net::Twitter
259 description => <<'EOT', Tests for the existence of friendship
260 between two users. Will return true if user_a follows user_b, otherwise
261 will return false.
262
263 Use of "user_a" and "user_b" is deprecated. It has been preserved for
264 backwards compatibility, and is used for the two-argument positional
265 form:
266
267 $nt->friendship_exists($user_a, $user_b);
268
269 Instead, you should use one of the named argument forms:
270
271 $nt->friendship_exists({ user_id_a => $id1, user_id_b => $id2 });
272 $nt->friendship_exists({ screen_name_a => $name1, screen_name_b => $name2 });
273
274 Consider using "show_friendship" instead. EOT
275
276 path => 'friendships/exists',
277 method => 'GET',
278 params => [qw/user_id_a user_id_b screen_name_a screen_name_b user_a user_b/],
279 required => [qw/user_a user_b/],
280 returns => 'Bool',
281 );
282
283 twitter_api_method no_retweet_ids => (
284 description => <<'', Returns an ARRAY ref of user IDs for which the
285 authenticating user does not want to receive retweets.
286
287 path => 'friendships/no_retweet_ids',
288 method => 'GET',
289 params => [],
290 required => [],
291 returns => 'ArrayRef[UserIDs]',
292 );
293
294 twitter_api_method friends_ids => (
295 description => <<'EOT', Returns a reference to an array of numeric
296 IDs for every user followed by the specified user. The order of the IDs
297 is reverse chronological.
298
299 Use the optional "cursor" parameter to retrieve IDs in pages of 5000.
300 When the "cursor" parameter is used, the return value is a reference to
301 a hash with keys "previous_cursor", "next_cursor", and "ids". The
302 value of "ids" is a reference to an array of IDS of the user's friends.
303 Set the optional "cursor" parameter to -1 to get the first page of IDs.
304 Set it to the prior return's value of "previous_cursor" or
305 "next_cursor" to page forward or backwards. When there are no prior
306 pages, the value of "previous_cursor" will be 0. When there are no
307 subsequent pages, the value of "next_cursor" will be 0. EOT
308
309 aliases => [qw/following_ids/],
310 path => 'friends/ids/:id',
311 method => 'GET',
312 params => [qw/id user_id screen_name cursor/],
313 required => [qw/id/],
314 returns => 'HashRef|ArrayRef[Int]',
315 );
316
317 twitter_api_method followers_ids => (
318 description => <<'EOT', Returns a reference to an array of numeric
319 IDs for every user following the specified user. The order of the IDs
320 may change from call to call. To obtain the screen names, pass the
321 arrayref to "lookup_users".
322
323 Use the optional "cursor" parameter to retrieve IDs in pages of 5000.
324 When the "cursor" parameter is used, the return value is a reference to
325 a hash with keys "previous_cursor", "next_cursor", and "ids". The
326 value of "ids" is a reference to an array of IDS of the user's
327 followers. Set the optional "cursor" parameter to -1 to get the first
328 page of IDs. Set it to the prior return's value of "previous_cursor"
329 or "next_cursor" to page forward or backwards. When there are no prior
330 pages, the value of "previous_cursor" will be 0. When there are no
331 subsequent pages, the value of "next_cursor" will be 0. EOT
332
333 path => 'followers/ids/:id',
334 method => 'GET',
335 params => [qw/id user_id screen_name cursor/],
336 required => [qw/id/],
337 returns => 'HashRef|ArrayRef[Int]',
338 );
339
340 twitter_api_method verify_credentials => (
341 description => <<'', Returns an HTTP 200 OK response code and a
342 representation of the requesting user if authentication was successful;
343 returns a 401 status code and an error message if not. Use this method
344 to test if supplied user credentials are valid.
345
346 path => 'account/verify_credentials',
347 method => 'GET',
348 params => [qw/include_entities/],
349 booleans => [qw/include_entities/],
350 required => [qw//],
351 returns => 'ExtendedUser',
352 );
353
354 twitter_api_method end_session => (
355 description => <<'', Ends the session of the authenticating user,
356 returning a null cookie. Use this method to sign users out of client-
357 facing applications like widgets.
358
359 path => 'account/end_session',
360 method => 'POST',
361 params => [qw//],
362 required => [qw//],
363 returns => 'Error', # HTTP Status: 200, error content. Silly!
364 );
365
366 twitter_api_method update_location => (
367 description => <<'', This method has been deprecated in favor of
368 the update_profile method. Its URL will continue to work, but please
369 consider migrating to the newer and more comprehensive method of
370 updating profile attributes.
371
372 deprecated => 1,
373 path => 'account/update_location',
374 method => 'POST',
375 params => [qw/location/],
376 required => [qw/location/],
377 returns => 'BasicUser',
378 );
379
380 twitter_api_method update_delivery_device => (
381 description => <<'', Sets which device Twitter delivers updates to
382 for the authenticating user. Sending none as the device parameter will
383 disable IM or SMS updates.
384
385 path => 'account/update_delivery_device',
386 method => 'POST',
387 params => [qw/device/],
388 required => [qw/device/],
389 returns => 'BasicUser',
390 );
391
392 twitter_api_method update_profile_colors => (
393 description => <<'', Sets one or more hex values that control the
394 color scheme of the authenticating user's profile page on twitter.com.
395 These values are also returned in the /users/show API method.
396
397 path => 'account/update_profile_colors',
398 method => 'POST',
399 params => [qw/
400 profile_background_color
401 profile_text_color
402 profile_link_color
403 profile_sidebar_fill_color
404 profile_sidebar_border_color
405 /],
406 required => [qw//],
407 returns => 'ExtendedUser',
408 );
409
410 twitter_api_method update_profile_image => (
411 description => <<'EOT', Updates the authenticating user's profile
412 image. The "image" parameter is an arrayref with the following
413 interpretation:
414
415 [ $file ]
416 [ $file, $filename ]
417 [ $file, $filename, Content_Type => $mime_type ]
418 [ undef, $filename, Content_Type => $mime_type, Content => $raw_image_data ]
419
420 The first value of the array ($file) is the name of a file to open.
421 The second value ($filename) is the name given to Twitter for the file.
422 If $filename is not provided, the basename portion of $file is used.
423 If $mime_type is not provided, it will be provided automatically using
424 LWP::MediaTypes::guess_media_type().
425
426 $raw_image_data can be provided, rather than opening a file, by passing
427 "undef" as the first array value. EOT
428
429 path => 'account/update_profile_image',
430 method => 'POST',
431 params => [qw/image/],
432 required => [qw/image/],
433 returns => 'ExtendedUser',
434 );
435
436 twitter_api_method update_profile_background_image => (
437 description => <<'', Updates the authenticating user's profile
438 background image. The "image" parameter must be an arrayref with the
439 same interpretation as the "image" parameter in the
440 "update_profile_image" method. The "use" parameter allows you to
441 specify whether to use the uploaded profile background or not. See
442 that method's documentation for details.
443
444 path => 'account/update_profile_background_image',
445 method => 'POST',
446 params => [qw/image use/],
447 required => [qw/image/],
448 booleans => [qw/use/],
449 returns => 'ExtendedUser',
450 );
451
452 twitter_api_method rate_limit_status => (
453 description => <<'EOT', Returns the remaining number of API
454 requests available to the authenticated user before the API limit is
455 reached for the current hour.
456
457 Use "->rate_limit_status({ authenticate => 0 })" to force an
458 unauthenticated call, which will return the status for the IP address
459 rather than the authenticated user. (Note: for a web application, this
460 is the server's IP address.) EOT
461
462 path => 'account/rate_limit_status',
463 method => 'GET',
464 params => [qw//],
465 required => [qw//],
466 returns => 'RateLimitStatus',
467 );
468
469 twitter_api_method update_profile => (
470 description => <<'', Sets values that users are able to set under
471 the "Account" tab of their settings page. Only the parameters specified
472 will be updated; to only update the "name" attribute, for example, only
473 include that parameter in your request.
474
475 path => 'account/update_profile',
476 method => 'POST',
477 params => [qw/ name email url location description include_entities/],
478 booleans => [qw/include_entities/],
479 required => [qw//],
480 returns => 'ExtendedUser',
481 );
482
483 twitter_api_method favorites => (
484 description => <<'', Returns the 20 most recent favorite statuses
485 for the authenticating user or user specified by the ID parameter.
486
487 path => 'favorites/:id',
488 method => 'GET',
489 params => [qw/id page include_entities/],
490 booleans => [qw/include_entities/],
491 required => [qw//],
492 returns => 'ArrayRef[Status]',
493 );
494
495 twitter_api_method create_favorite => (
496 description => <<'', Favorites the status specified in the ID
497 parameter as the authenticating user. Returns the favorite status when
498 successful.
499
500 path => 'favorites/create/:id',
501 method => 'POST',
502 params => [qw/id include_entities/],
503 booleans => [qw/include_entities/],
504 required => [qw/id/],
505 returns => 'Status',
506 );
507
508 twitter_api_method destroy_favorite => (
509 description => <<'', Un-favorites the status specified in the ID
510 parameter as the authenticating user. Returns the un-favorited status.
511
512 path => 'favorites/destroy/:id',
513 method => 'POST',
514 params => [qw/id include_entities/],
515 booleans => [qw/include_entities/],
516 required => [qw/id/],
517 returns => 'Status',
518 );
519
520 twitter_api_method enable_notifications => (
521 description => <<'', Enables notifications for updates from the
522 specified user to the authenticating user. Returns the specified user
523 when successful.
524
525 path => 'notifications/follow/:id',
526 method => 'POST',
527 params => [qw/id screen_name include_entities/],
528 booleans => [qw/include_entities/],
529 required => [qw/id/],
530 returns => 'BasicUser',
531 );
532
533 twitter_api_method disable_notifications => (
534 description => <<'', Disables notifications for updates from the
535 specified user to the authenticating user. Returns the specified user
536 when successful.
537
538 path => 'notifications/leave/:id',
539 method => 'POST',
540 params => [qw/id screen_name include_entities/],
541 booleans => [qw/include_entities/],
542 required => [qw/id/],
543 returns => 'BasicUser',
544 );
545
546 twitter_api_method create_block => (
547 description => <<'', Blocks the user specified in the ID parameter
548 as the authenticating user. Returns the blocked user when successful.
549 You can find out more about blocking in the Twitter Support Knowledge
550 Base.
551
552 path => 'blocks/create/:id',
553 method => 'POST',
554 params => [qw/id user_id screen_name include_entities/],
555 booleans => [qw/include_entities/],
556 required => [qw/id/],
557 returns => 'BasicUser',
558 );
559
560 twitter_api_method destroy_block => (
561 description => <<'', Un-blocks the user specified in the ID
562 parameter as the authenticating user. Returns the un-blocked user when
563 successful.
564
565 path => 'blocks/destroy/:id',
566 method => 'POST',
567 params => [qw/id user_id screen_name/],
568 booleans => [qw/include_entities/],
569 required => [qw/id/],
570 returns => 'BasicUser',
571 );
572
573 twitter_api_method block_exists => (
574 description => <<'', Returns if the authenticating user is blocking
575 a target user. Will return the blocked user's object if a block exists,
576 and error with HTTP 404 response code otherwise.
577
578 path => 'blocks/exists/:id',
579 method => 'GET',
580 params => [qw/id user_id screen_name include_entities/],
581 booleans => [qw/include_entities/],
582 required => [qw/id/],
583 returns => 'BasicUser',
584 );
585
586 twitter_api_method blocking => (
587 description => <<'', Returns an array of user objects that the
588 authenticating user is blocking.
589
590 path => 'blocks/blocking',
591 method => 'GET',
592 params => [qw/page include_entities/],
593 booleans => [qw/include_entities/],
594 required => [qw//],
595 returns => 'ArrayRef[BasicUser]',
596 );
597
598 twitter_api_method blocking_ids => (
599 description => <<'', Returns an array of numeric user ids the
600 authenticating user is blocking.
601
602 path => 'blocks/blocking/ids',
603 method => 'GET',
604 params => [qw//],
605 required => [qw//],
606 returns => 'ArrayRef[Int]',
607 );
608
609 twitter_api_method test => (
610 description => <<'', Returns the string "ok" status code.
611
612 path => 'help/test',
613 method => 'GET',
614 params => [qw//],
615 required => [qw//],
616 returns => 'Str',
617 );
618
619 twitter_api_method downtime_schedule => (
620 description => <<'', Returns the same text displayed on
621 <http://twitter.com/home> when a maintenance window is scheduled.
622
623 deprecated => 1,
624 path => 'help/downtime_schedule',
625 method => 'GET',
626 params => [qw//],
627 required => [qw//],
628 returns => 'Str',
629 );
630
631 twitter_api_method get_configuration => (
632 path => 'help/configuration',
633 method => 'GET',
634 params => [],
635 required => [],
636 returns => 'HashRef',
637 description => <<'EOT', Returns the current configuration used by
638 Twitter including twitter.com slugs which are not usernames, maximum
639 photo resolutions, and t.co URL lengths.
640
641 It is recommended applications request this endpoint when they are
642 loaded, but no more than once a day. EOT
643
644 );
645
646 twitter_api_method get_languages => (
647 path => 'help/languages',
648 method => 'GET',
649 params => [],
650 required => [],
651 returns => 'ArrayRef[Lanugage]',
652 description => <<'', Returns the list of languages supported by
653 Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two
654 letter value to use if you include lang with any of your requests.
655
656 );
657
658 twitter_api_method saved_searches => (
659 description => <<'', Returns the authenticated user's saved search
660 queries.
661
662 path => 'saved_searches',
663 method => 'GET',
664 params => [],
665 required => [],
666 returns => 'ArrayRef[SavedSearch]',
667 );
668
669 twitter_api_method show_saved_search => (
670 description => <<'', Retrieve the data for a saved search, by "id",
671 owned by the authenticating user.
672
673 path => 'saved_searches/show/:id',
674 method => 'GET',
675 params => [qw/id/],
676 required => [qw/id/],
677 returns => 'SavedSearch',
678 );
679
680 twitter_api_method create_saved_search => (
681 description => <<'', Creates a saved search for the authenticated
682 user.
683
684 path => 'saved_searches/create',
685 method => 'POST',
686 params => [qw/query/],
687 required => [qw/query/],
688 returns => 'SavedSearch',
689 );
690
691 twitter_api_method destroy_saved_search => (
692 description => <<'', Destroys a saved search. The search, specified
693 by "id", must be owned by the authenticating user.
694
695 path => 'saved_searches/destroy/:id',
696 method => 'POST',
697 params => [qw/id/],
698 required => [qw/id/],
699 returns => 'SavedSearch',
700 );
701
702 twitter_api_method report_spam => (
703 description => <<'', The user specified in the id is blocked by the
704 authenticated user and reported as a spammer.
705
706 path => 'report_spam',
707 method => 'POST',
708 params => [qw/id user_id screen_name include_entities/],
709 booleans => [qw/include_entities/],
710 required => [qw/id/],
711 returns => 'User',
712 );
713
714 twitter_api_method users_search => (
715 aliases => [qw/find_people search_users/],
716 path => 'users/search',
717 method => 'GET',
718 params => [qw/q per_page page include_entities/],
719 booleans => [qw/include_entities/],
720 required => [qw/q/],
721 returns => 'ArrayRef[Users]',
722 description => <<'', Run a search for users similar to Find People
723 button on Twitter.com; the same results returned by people search on
724 Twitter.com will be returned by using this API (about being listed in
725 the People Search). It is only possible to retrieve the first 1000
726 matches from this API.
727
728 );
729
730 twitter_api_method trends_available => (
731 path => 'trends/available',
732 method => 'GET',
733 params => [qw/lat long/],
734 required => [],
735 authenticate => 0,
736 returns => 'ArrayRef[Location]',
737 description => <<EOT, Returns the locations with trending topic
738 information. The response is an array of "locations" that encode the
739 location's WOEID (a Yahoo! Where On Earth ID
740 <http://developer.yahoo.com/geo/geoplanet/>) and some other human-
741 readable information such as a the location's canonical name and
742 country.
743
744 When the optional "lat" and "long" parameters are passed, the available
745 trend locations are sorted by distance from that location, nearest to
746 farthest.
747
748 Use the WOEID returned in the location object to query trends for a
749 specific location. EOT );
750
751 twitter_api_method trends_location => (
752 path => 'trends/:woeid',
753 method => 'GET',
754 params => [qw/woeid/],
755 required => [qw/woeid/],
756 returns => 'ArrayRef[Trend]',
757 authenticate => 0,
758 description => <<'', Returns the top 10 trending topics for a
759 specific location. The response is an array of "trend" objects that
760 encode the name of the trending topic, the query parameter that can be
761 used to search for the topic on Search, and the direct URL that can be
762 issued against Search. This information is cached for five minutes,
763 and therefore users are discouraged from querying these endpoints
764 faster than once every five minutes. Global trends information is also
765 available from this API by using a WOEID of 1.
766
767 );
768
769 twitter_api_method trends => (
770 description => <<'', Returns the top ten queries that are currently
771 trending on Twitter. The response includes the time of the request,
772 the name of each trending topic, and the url to the Twitter Search
773 results page for that topic.
774
775 path => 'trends',
776 method => 'GET',
777 params => [qw//],
778 required => [qw//],
779 authenticate => 0,
780 returns => 'ArrayRef[Query]',
781 deprecated => 1,
782 );
783
784 my $trends_deprecation_warned = 0; around trends => sub {
785 my $orig = shift;
786 my $self = shift;
787
788 my $args = ref $_[-1] eq ref {} ? pop : {};
789
790 $trends_deprecation_warned ||= do {
791 local $Carp::CarpLevel = 3;
792 carp "The 'trends' API method has been deprecated; instead, use trends_location({ woeid => 1 })";
793 1;
794 };
795
796 $args->{woeid} = 1;
797
798 return $self->trends_location(@_, $args);
799 };
800
801 twitter_api_method trends_current => (
802 description => <<'', Returns the current top ten trending topics on
803 Twitter. The response includes the time of the request, the name of
804 each trending topic, and query used on Twitter Search results page for
805 that topic.
806
807 path => 'trends/current',
808 method => 'GET',
809 params => [qw/exclude/],
810 required => [qw//],
811 authenticate => 0,
812 returns => 'HashRef',
813 );
814
815 twitter_api_method trends_daily => (
816 description => <<'', Returns the top 20 trending topics for each
817 hour in a given day.
818
819 path => 'trends/daily',
820 method => 'GET',
821 params => [qw/date exclude/],
822 required => [qw//],
823 authenticate => 0,
824 returns => 'HashRef',
825 );
826
827 twitter_api_method trends_weekly => (
828 description => <<'', Returns the top 30 trending topics for each
829 day in a given week.
830
831 path => 'trends/weekly',
832 method => 'GET',
833 params => [qw/date exclude/],
834 required => [qw//],
835 authenticate => 0,
836 returns => 'HashRef',
837 );
838
839 twitter_api_method reverse_geocode => (
840 path => 'geo/reverse_geocode',
841 method => 'GET',
842 params => [qw/lat long accuracy granularity max_results/],
843 required => [qw/lat long/],
844 returns => 'HashRef',
845 description => <<'EOT',
846
847 Search for places (cities and neighborhoods) that can be attached to a
848 statuses/update. Given a latitude and a longitude, return a list of
849 all the valid places that can be used as a place_id when updating a
850 status. Conceptually, a query can be made from the user's location,
851 retrieve a list of places, have the user validate the location he or
852 she is at, and then send the ID of this location up with a call to
853 statuses/update.
854
855 There are multiple granularities of places that can be returned --
856 "neighborhoods", "cities", etc. At this time, only United States data
857 is available through this method.
858
859 lat Required. The latitude to query about. Valid ranges are -90.0 to
860 +90.0 (North is positive) inclusive.
861
862 long
863 Required. The longitude to query about. Valid ranges are -180.0 to
864 +180.0 (East is positive) inclusive.
865
866 accuracy
867 Optional. A hint on the "region" in which to search. If a number,
868 then this is a radius in meters, but it can also take a string that
869 is suffixed with ft to specify feet. If this is not passed in,
870 then it is assumed to be 0m. If coming from a device, in practice,
871 this value is whatever accuracy the device has measuring its
872 location (whether it be coming from a GPS, WiFi triangulation,
873 etc.).
874
875 granularity
876 Optional. The minimal granularity of data to return. If this is
877 not passed in, then "neighborhood" is assumed. "city" can also be
878 passed.
879
880 max_results
881 Optional. A hint as to the number of results to return. This does
882 not guarantee that the number of results returned will equal
883 max_results, but instead informs how many "nearby" results to
884 return. Ideally, only pass in the number of places you intend to
885 display to the user here.
886
887 EOT );
888
889 twitter_api_method geo_id => (
890 path => 'geo/id/:id',
891 method => 'GET',
892 params => [qw/id/],
893 required => [qw/id/],
894 returns => 'HashRef',
895 description => <<'EOT', Returns details of a place returned from
896 the "reverse_geocode" method. EOT );
897
898 twitter_api_method geo_search => (
899 path => 'geo/search',
900 method => 'GET',
901 params => [qw/
902 lat long query ip granularity accuracy max_results
903 contained_within attribute:street_address callback
904 /],
905 required => [],
906 returns => 'HashRef',
907 description => <<'EOT', Search for places that can be attached to a
908 statuses/update. Given a latitude and a longitude pair, an IP address,
909 or a name, this request will return a list of all the valid places that
910 can be used as the place_id when updating a status.
911
912 Conceptually, a query can be made from the user's location, retrieve a
913 list of places, have the user validate the location he or she is at,
914 and then send the ID of this location with a call to statuses/update.
915
916 This is the recommended method to use find places that can be attached
917 to statuses/update. Unlike geo/reverse_geocode which provides raw data
918 access, this endpoint can potentially re-order places with regards to
919 the user who is authenticated. This approach is also preferred for
920 interactive place matching with the user. EOT
921
922 );
923
924 twitter_api_method similar_places => (
925 path => 'geo/similar_places',
926 method => 'GET',
927 params => [qw/lat long name contained_within
928 attribute:street_address callback/],
929 required => [qw/lat long name/],
930 returns => 'HashRef',
931 description => <<'EOT', Locates places near the given coordinates
932 which are similar in name.
933
934 Conceptually you would use this method to get a list of known places to
935 choose from first. Then, if the desired place doesn't exist, make a
936 request to "add_place" to create a new one.
937
938 The token contained in the response is the token needed to be able to
939 create a new place. EOT
940
941 );
942
943 twitter_api_method add_place => (
944 path => 'geo/place',
945 method => 'POST',
946 params => [qw/name contained_within token lat long
947 attribute:street_address callback/],
948 required => [qw/name contained_within token lat long/],
949 returns => 'Place',
950 description => <<'EOT', Creates a new place object at the given
951 latitude and longitude.
952
953 Before creating a place you need to query "similar_places" with the
954 latitude, longitude and name of the place you wish to create. The query
955 will return an array of places which are similar to the one you wish to
956 create, and a token. If the place you wish to create isn't in the
957 returned array you can use the token with this method to create a new
958 one. EOT
959
960 );
961
962 twitter_api_method lookup_users => (
963 path => 'users/lookup',
964 method => 'GET',
965 params => [qw/user_id screen_name include_entities/],
966 booleans => [qw/include_entities/],
967 required => [],
968 returns => 'ArrayRef[User]',
969 description => <<'EOT' Return up to 100 users worth of extended
970 information, specified by either ID, screen name, or combination of the
971 two. The author's most recent status (if the authenticating user has
972 permission) will be returned inline. This method is rate limited to
973 1000 calls per hour.
974
975 This method will accept user IDs or screen names as either a comma
976 delimited string, or as an ARRAY ref. It will also accept arguments in
977 the normal HASHREF form or as a simple list of named arguments. I.e.,
978 any of the following forms are acceptable:
979
980 $nt->lookup_users({ user_id => '1234,6543,3333' });
981 $nt->lookup_users(user_id => '1234,6543,3333');
982 $nt->lookup_users({ user_id => [ 1234, 6543, 3333 ] });
983 $nt->lookup_users({ screen_name => 'fred,barney,wilma' });
984 $nt->lookup_users(screen_name => ['fred', 'barney', 'wilma']);
985
986 $nt->lookup_users(
987 screen_name => ['fred', 'barney' ],
988 user_id => '4321,6789',
989 );
990
991 EOT );
992
993 twitter_api_method retweeted_by => (
994 path => 'statuses/:id/retweeted_by',
995 method => 'GET',
996 params => [qw/id count page trim_user include_entities/],
997 booleans => [qw/include_entities trim_user/],
998 required => [qw/id/],
999 returns => 'ArrayRef[User]',
1000 description => <<'' Returns up to 100 users who retweeted the
1001 status identified by "id".
1002
1003 );
1004
1005 twitter_api_method retweeted_by_ids => (
1006 path => 'statuses/:id/retweeted_by/ids',
1007 method => 'GET',
1008 params => [qw/id count page trim_user include_entities/],
1009 booleans => [qw/include_entities trim_user/],
1010 required => [qw/id/],
1011 returns => 'ArrayRef[User]',
1012 description => <<'' Returns the IDs of up to 100 users who
1013 retweeted the status identified by "id".
1014
1015 );
1016
1017 twitter_api_method friendships_incoming => (
1018 path => 'friendships/incoming',
1019 method => 'GET',
1020 params => [qw/cursor/],
1021 required => [qw/cursor/],
1022 returns => 'HashRef',
1023 description => <<'', Returns an HASH ref with an array of numeric
1024 IDs in the "ids" element for every user who has a pending request to
1025 follow the authenticating user.
1026
1027 );
1028
1029 twitter_api_method friendships_outgoing => (
1030 path => 'friendships/outgoing',
1031 method => 'GET',
1032 params => [qw/cursor/],
1033 required => [qw/cursor/],
1034 returns => 'HashRef',
1035 description => <<'', Returns an HASH ref with an array of numeric
1036 IDs in the "ids" element for every protected user for whom the
1037 authenticating user has a pending follow request.
1038
1039 );
1040
1041 # new in 3.17001 2010-10-19
1042
1043 twitter_api_method account_totals => (
1044 path => 'account/totals',
1045 method => 'GET',
1046 params => [],
1047 required => [],
1048 returns => 'HashRef',
1049 description => <<'' Returns the current count of friends,
1050 followers, updates (statuses) and favorites of the authenticating user.
1051
1052 );
1053
1054 twitter_api_method account_settings => (
1055 path => 'account/settings',
1056 method => 'GET',
1057 params => [],
1058 required => [],
1059 returns => 'HashRef',
1060 description => <<'' Returns the current trend, geo and sleep time
1061 information for the authenticating user.
1062
1063 );
1064
1065 twitter_api_method suggestion_categories => (
1066 path => 'users/suggestions',
1067 method => 'GET',
1068 params => [],
1069 required => [],
1070 returns => 'ArrayRef',
1071 description => <<'' Returns the list of suggested user categories.
1072 The category slug can be used in the "user_suggestions" API method get
1073 the users in that category . Does not require authentication.
1074
1075 );
1076
1077 twitter_api_method user_suggestions => (
1078 aliases => [qw/follow_suggestions/],
1079 path => 'users/suggestions/:category/members',
1080 method => 'GET',
1081 params => [qw/category lang/],
1082 required => [qw/category/],
1083 returns => 'ArrayRef',
1084 description => <<'' Access the users in a given category of the
1085 Twitter suggested user list and return their most recent status if they
1086 are not a protected user. Currently supported values for optional
1087 parameter "lang" are "en", "fr", "de", "es", "it". Does not require
1088 authentication.
1089
1090 );
1091
1092 twitter_api_method show_direct_message => (
1093 path => 'direct_messages/show/:id',
1094 method => 'GET',
1095 params => [qw/id include_entities/],
1096 booleans => [qw/include_entities/],
1097 required => [qw/id/],
1098 returns => 'HashRef',
1099 description => <<'' Returns a single direct message, specified by
1100 an id parameter. Like the "direct_messages" request, this method will
1101 include the user objects of the sender and recipient. Requires
1102 authentication.
1103
1104 );
1105
1106 twitter_api_method retweeted_to_user => (
1107 path => 'statuses/retweeted_to_user',
1108 method => 'GET',
1109 params => [qw/id user_id screen_name/],
1110 required => [qw/id/],
1111 returns => 'ArrayRef',
1112 description => <<'' Returns the 20 most recent retweets posted by
1113 users the specified user follows. The user is specified using the
1114 user_id or screen_name parameters. This method is identical to
1115 "retweeted_to_me" except you can choose the user to view. Does not
1116 require authentication, unless the user is protected.
1117
1118 );
1119
1120 twitter_api_method retweeted_by_user => (
1121 path => 'statuses/retweeted_by_user',
1122 method => 'GET',
1123 params => [qw/id user_id screen_name/],
1124 required => [qw/id/],
1125 returns => 'ArrayRef',
1126 description => <<'' Returns the 20 most recent retweets posted by
1127 the specified user. The user is specified using the user_id or
1128 screen_name parameters. This method is identical to "retweeted_by_me"
1129 except you can choose the user to view. Does not require
1130 authentication, unless the user is protected.
1131
1132 );
1133
1134 twitter_api_method lookup_friendships => (
1135 path => 'friendships/lookup',
1136 method => 'GET',
1137 params => [qw/user_id screen_name/],
1138 required => [],
1139 returns => 'ArrayRef',
1140 description => <<'' Returns the relationship of the authenticating
1141 user to the comma separated list or ARRAY ref of up to 100 screen_names
1142 or user_ids provided. Values for connections can be: following,
1143 following_requested, followed_by, none. Requires authentication.
1144
1145 );
1146
1147 twitter_api_method update_friendship => (
1148 path => 'friendships/update',
1149 method => 'POST',
1150 params => [qw/id user_id screen_name device retweets/],
1151 required => [qw/id/],
1152 booleans => [qw/device retweets/],
1153 returns => 'HashRef',
1154 description => <<'' Allows you enable or disable retweets and
1155 device notifications from the specified user. All other values are
1156 assumed to be false. Requires authentication.
1157
1158 );
1159
1160 twitter_api_method related_results => (
1161 path => 'related_results/show/:id',
1162 method => 'GET',
1163 params => [qw/id/],
1164 required => [qw/id/],
1165 returns => 'ArrayRef[Status]',
1166 description => <<'' If available, returns an array of replies and
1167 mentions related to the specified status. There is no guarantee there
1168 will be any replies or mentions in the response. This method is only
1169 available to users who have access to #newtwitter. Requires
1170 authentication.
1171
1172 );
1173
1174 ### Lists ###
1175
1176 twitter_api_method all_subscriptions => (
1177 path => 'lists/all',
1178 method => 'GET',
1179 params => [qw/user_id screen_name count cursor/],
1180 required => [],
1181 returns => 'ArrayRef[List]',
1182 aliases => [qw/all_lists list_subscriptions/],
1183 description => <<'', Returns all lists the authenticating or
1184 specified user subscribes to, including their own. The user is
1185 specified using the user_id or screen_name parameters. If no user is
1186 given, the authenticating user is used.
1187
1188 );
1189
1190 twitter_api_method list_statuses => (
1191 path => 'lists/statuses',
1192 method => 'GET',
1193 params => [qw/
1194 list_id slug owner_screen_name owner_id since_id max_id
1195 per_page page
1196 include_entities include_rts
1197 /],
1198 required => [],
1199 booleans => [qw/include_entities include_rts/],
1200 returns => 'ArrayRef[Status]',
1201 description => <<'', Returns tweet timeline for members of the
1202 specified list. Historically, retweets were not available in list
1203 timeline responses but you can now use the include_rts=true parameter
1204 to additionally receive retweet objects.
1205
1206 );
1207
1208 twitter_api_method delete_list_member => (
1209 path => 'lists/members/destroy',
1210 method => 'POST',
1211 params => [qw/list_id slug user_id screen_name
1212 owner_screen_name owner_id/],
1213 required => [],
1214 returns => 'User',
1215 aliases => [qw/remove_list_member/],
1216 description => <<'', Removes the specified member from the list.
1217 The authenticated user must be the list's owner to remove members from
1218 the list.
1219
1220 );
1221
1222 twitter_api_method list_memberships => (
1223 path => 'lists/memberships',
1224 method => 'GET',
1225 params => [qw/user_id screen_name cursor
1226 filter_to_owned_lists/],
1227 required => [],
1228 booleans => [qw/filter_to_owned_lists/],
1229 returns => 'Hashref',
1230 description => <<'', Returns the lists the specified user has been
1231 added to. If user_id or screen_name are not provided the memberships
1232 for the authenticating user are returned.
1233
1234 );
1235
1236 twitter_api_method list_subscribers => (
1237 path => 'lists/subscribers',
1238 method => 'GET',
1239 params => [qw/list_id slug owner_screen_name owner_id cursor
1240 include_entities skip_status/],
1241 required => [],
1242 booleans => [qw/include_entities skip_status/],
1243 returns => 'Hashref',
1244 description => <<'', Returns the subscribers of the specified list.
1245 Private list subscribers will only be shown if the authenticated user
1246 owns the specified list.
1247
1248 );
1249
1250 twitter_api_method subscribe_list => (
1251 path => 'lists/subscribers/create',
1252 method => 'POST',
1253 params => [qw/owner_screen_name owner_id list_id slug/],
1254 required => [],
1255 returns => 'List',
1256 description => <<'', Subscribes the authenticated user to the
1257 specified list.
1258
1259 );
1260
1261 twitter_api_method is_list_subscriber => (
1262 path => 'lists/subscribers/show',
1263 method => 'GET',
1264 params => [qw/
1265 owner_screen_name owner_id list_id slug user_id screen_name
1266 include_entities skip_status
1267 /],
1268 required => [],
1269 booleans => [qw/include_entities skip_status/],
1270 returns => 'Maybe[User]',
1271 aliases => [qw/is_subscribed_list/],
1272 description => <<'', Check if the specified user is a subscriber of
1273 the specified list. Returns the user or undef.
1274
1275 );
1276
1277 around [qw/is_list_subscriber is_subscribed_list/] => sub {
1278 my $orig = shift;
1279 my $self = shift;
1280
1281 $self->_user_or_undef($orig, 'subscriber', @_);
1282 };
1283
1284 twitter_api_method unsubscribe_list => (
1285 path => 'lists/subscribers/destroy',
1286 method => 'POST',
1287 params => [qw/list_id slug owner_screen_name owner_id/],
1288 required => [],
1289 returns => 'List',
1290 description => <<'', Unsubscribes the authenticated user from the
1291 specified list.
1292
1293 );
1294
1295 twitter_api_method members_create_all => (
1296 path => 'lists/members/create_all',
1297 method => 'POST',
1298 params => [qw/list_id slug owner_screen_name owner_id/],
1299 required => [],
1300 returns => 'List',
1301 aliases => [qw/add_list_members/],
1302 description => <<'', Adds multiple members to a list, by specifying
1303 a reference to an array or a comma-separated list of member ids or
1304 screen names. The authenticated user must own the list to be able to
1305 add members to it. Note that lists can't have more than 500 members,
1306 and you are limited to adding up to 100 members to a list at a time
1307 with this method.
1308
1309 );
1310
1311 twitter_api_method members_destroy_all => (
1312 path => 'lists/members/destroy_all',
1313 method => 'POST',
1314 params => [qw/list_id slug user_id screen_name
1315 owner_screen_name owner_id/],
1316 required => [],
1317 returns => 'List',
1318 aliases => [qw/remove_list_members/],
1319 description => <<'EOT', Removes multiple members from a list, by
1320 specifying a reference to an array of member ids or screen names, or a
1321 string of comma separated user ids or screen names. The authenticated
1322 user must own the list to be able to remove members from it. Note that
1323 lists can't have more than 500 members, and you are limited to removing
1324 up to 100 members to a list at a time with this method.
1325
1326 Please note that there can be issues with lists that rapidly remove and
1327 add memberships. Take care when using these methods such that you are
1328 not too rapidly switching between removals and adds on the same list.
1329
1330 EOT );
1331
1332 twitter_api_method is_list_member => (
1333 path => 'lists/members/show',
1334 method => 'GET',
1335 params => [qw/
1336 owner_screen_name owner_id list_id slug user_id screen_name
1337 include_entities skip_status
1338 /],
1339 required => [],
1340 booleans => [qw/include_entities skip_status/],
1341 returns => 'Maybe[User]',
1342 description => <<'', Check if the specified user is a member of the
1343 specified list. Returns the user or undef.
1344
1345 );
1346
1347 around is_list_member => sub {
1348 my $orig = shift;
1349 my $self = shift;
1350
1351 $self->_user_or_undef($orig, 'member', @_);
1352 };
1353
1354 twitter_api_method list_members => (
1355 path => 'lists/members',
1356 method => 'GET',
1357 params => [qw/
1358 list_id slug owner_screen_name owner_id cursor
1359 include_entities skip_status
1360 /],
1361 required => [],
1362 booleans => [qw/include_entities skip_status/],
1363 returns => 'Hashref',
1364 description => <<'', Returns the members of the specified list.
1365 Private list members will only be shown if the authenticated user owns
1366 the specified list.
1367
1368 );
1369
1370 twitter_api_method add_list_member => (
1371 path => 'lists/members/create',
1372 method => 'POST',
1373 params => [qw/list_id slug user_id screen_name
1374 owner_screen_name owner_id/],
1375 required => [],
1376 returns => 'User',
1377 description => <<'', Add a member to a list. The authenticated user
1378 must own the list to be able to add members to it. Note that lists
1379 can't have more than 500 members.
1380
1381 );
1382
1383 twitter_api_method delete_list => (
1384 path => 'lists/destroy',
1385 method => 'POST',
1386 params => [qw/owner_screen_name owner_id list_id slug/],
1387 required => [],
1388 returns => 'List',
1389 description => <<'', Deletes the specified list. The authenticated
1390 user must own the list to be able to destroy it.
1391
1392 );
1393
1394 twitter_api_method update_list => (
1395 path => 'lists/update',
1396 method => 'POST',
1397 params => [qw/list_id slug name mode description
1398 owner_screen_name owner_id/],
1399 required => [],
1400 returns => 'List',
1401 description => <<'', Updates the specified list. The authenticated
1402 user must own the list to be able to update it.
1403
1404 );
1405
1406 twitter_api_method create_list => (
1407 path => 'lists/create',
1408 method => 'POST',
1409 params => [qw/list_id slug name mode description
1410 owner_screen_name owner_id/],
1411 required => [],
1412 returns => 'List',
1413 description => <<'', Creates a new list for the authenticated user.
1414 Note that you can't create more than 20 lists per account.
1415
1416 );
1417
1418 twitter_api_method get_lists => (
1419 path => 'lists',
1420 method => 'GET',
1421 params => [qw/user_id screen_name cursor/],
1422 required => [],
1423 returns => 'Hashref',
1424 aliases => [qw/list_lists/],
1425 description => <<'', Returns the lists of the specified (or
1426 authenticated) user. Private lists will be included if the
1427 authenticated user is the same as the user whose lists are being
1428 returned.
1429
1430 );
1431
1432 twitter_api_method get_list => (
1433 path => 'lists/show',
1434 method => 'GET',
1435 params => [qw/list_id slug owner_screen_name owner_id/],
1436 required => [],
1437 returns => 'List',
1438 description => <<'', Returns the specified list. Private lists will
1439 only be shown if the authenticated user owns the specified list.
1440
1441 );
1442
1443 twitter_api_method subscriptions => (
1444 path => 'lists/subscriptions',
1445 method => 'GET',
1446 params => [qw/user_id screen_name count cursor/],
1447 required => [],
1448 returns => 'ArrayRef[List]',
1449 aliases => [],
1450 description => <<'', Obtain a collection of the lists the specified
1451 user is subscribed to, 20 lists per page by default. Does not include
1452 the user's own lists.
1453
1454 );
1455
1456 ### Legal ###
1457
1458 twitter_api_method get_privacy_policy => (
1459 path => 'legal/privacy',
1460 method => 'GET',
1461 params => [],
1462 required => [],
1463 returns => 'HashRef',
1464 description => <<'', Returns Twitter's privacy policy.
1465
1466 );
1467
1468 twitter_api_method get_tos => (
1469 path => 'legal/tos',
1470 method => 'GET',
1471 params => [],
1472 required => [],
1473 returns => 'HashRef',
1474 description => <<'', Returns the Twitter Terms of Service. These
1475 are not the same as the Developer Rules of the Road.
1476
1477 );
1478
1479 1;
1480
1481 __END__
1482
1484 Net::Twitter::Role::API::REST - A definition of the Twitter REST API as
1485 a Moose role
1486
1488 version 4.01043
1489
1491 package My::Twitter;
1492 use Moose;
1493 with 'Net::Twitter::API::REST';
1494
1496 Net::Twitter::Role::API::REST provides definitions for all the Twitter
1497 REST API methods. Applying this role to any class provides methods for
1498 all of the Twitter REST API methods.
1499
1501 Marc Mims <marc@questright.com>
1502
1504 Copyright (c) 2016 Marc Mims
1505
1506 The Twitter API itself, and the description text used in this module
1507 is:
1508
1509 Copyright (c) 2009 Twitter
1510
1511 This library is free software; you can redistribute it and/or modify it
1512 under the same terms as Perl itself.
1513
1515 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
1516 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
1517 WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
1518 PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
1519 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1520 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
1521 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
1522 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
1523 NECESSARY SERVICING, REPAIR, OR CORRECTION.
1524
1525 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
1526 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
1527 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE
1528 TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
1529 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
1530 SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
1531 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
1532 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
1533 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
1534 DAMAGES.
1535
1536
1537
1538perl v5.36.0 2022-07-22 Net::Twitter::Role::API::REST(3)