friends_and_followers.rb in twitter-5.15.0

- old
+ new

@@ -10,11 +10,11 @@
   module REST
     module FriendsAndFollowers
       include Twitter::REST::Utils
       include Twitter::Utils
 
-      # @see https://dev.twitter.com/docs/api/1.1/get/friends/ids
+      # @see https://dev.twitter.com/rest/reference/get/friends/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload friend_ids(options = {})
@@ -28,11 +28,11 @@
       #   @param options [Hash] A customizable set of options.
       def friend_ids(*args)
         cursor_from_response_with_user(:ids, nil, '/1.1/friends/ids.json', args)
       end
 
-      # @see https://dev.twitter.com/docs/api/1.1/get/followers/ids
+      # @see https://dev.twitter.com/rest/reference/get/followers/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload follower_ids(options = {})
@@ -48,11 +48,11 @@
         cursor_from_response_with_user(:ids, nil, '/1.1/followers/ids.json', args)
       end
 
       # Returns the relationship of the authenticating user to the comma separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/lookup
+      # @see https://dev.twitter.com/rest/reference/get/friendships/lookup
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The requested users.
       # @overload friendships(*users)
@@ -66,11 +66,11 @@
         perform_get_with_objects('/1.1/friendships/lookup.json', arguments.options, Twitter::User)
       end
 
       # Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/incoming
+      # @see https://dev.twitter.com/rest/reference/get/friendships/incoming
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
@@ -78,11 +78,11 @@
         perform_get_with_cursor('/1.1/friendships/incoming.json', options, :ids)
       end
 
       # Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/outgoing
+      # @see https://dev.twitter.com/rest/reference/get/friendships/outgoing
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @param options [Hash] A customizable set of options.
@@ -90,11 +90,11 @@
         perform_get_with_cursor('/1.1/friendships/outgoing.json', options, :ids)
       end
 
       # Allows the authenticating user to follow the specified users, unless they are already followed
       #
-      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/create
+      # @see https://dev.twitter.com/rest/reference/post/friendships/create
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The followed users.
       # @overload follow(*users)
@@ -116,11 +116,11 @@
       alias_method :create_friendship, :follow
       deprecate_alias :friendship_create, :follow
 
       # Allows the authenticating user to follow the specified users
       #
-      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/create
+      # @see https://dev.twitter.com/rest/reference/post/friendships/create
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The followed users.
       # @overload follow!(*users)
@@ -138,11 +138,11 @@
       alias_method :create_friendship!, :follow!
       deprecate_alias :friendship_create!, :follow!
 
       # Allows the authenticating user to unfollow the specified users
       #
-      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/destroy
+      # @see https://dev.twitter.com/rest/reference/post/friendships/destroy
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Twitter::User>] The unfollowed users.
       # @overload unfollow(*users)
@@ -156,11 +156,11 @@
       alias_method :destroy_friendship, :unfollow
       deprecate_alias :friendship_destroy, :unfollow
 
       # Allows one to enable or disable retweets and device notifications from the specified user.
       #
-      # @see https://dev.twitter.com/docs/api/1.1/post/friendships/update
+      # @see https://dev.twitter.com/rest/reference/post/friendships/update
       # @rate_limited No
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Relationship]
       # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
@@ -172,11 +172,11 @@
         perform_post_with_object('/1.1/friendships/update.json', options, Twitter::Relationship)
       end
 
       # Returns detailed information about the relationship between two users
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @see https://dev.twitter.com/rest/reference/get/friendships/show
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Relationship]
       # @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user.
@@ -192,11 +192,11 @@
       alias_method :friendship_show, :friendship
       alias_method :relationship, :friendship
 
       # Test for the existence of friendship between two users
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/show
+      # @see https://dev.twitter.com/rest/reference/get/friendships/show
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Boolean] true if user_a follows user_b, otherwise false.
       # @param source [Integer, String, Twitter::User] The Twitter user ID, screen name, or object of the source user.
@@ -206,11 +206,11 @@
         friendship(source, target, options).source.following?
       end
 
       # Returns a cursored collection of user objects for users following the specified user.
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/followers/list
+      # @see https://dev.twitter.com/rest/reference/get/followers/list
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload followers(options = {})
@@ -230,11 +230,11 @@
         cursor_from_response_with_user(:users, Twitter::User, '/1.1/followers/list.json', args)
       end
 
       # Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their "friends").
       #
-      # @see https://dev.twitter.com/docs/api/1.1/get/friends/list
+      # @see https://dev.twitter.com/rest/reference/get/friends/list
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Twitter::Cursor]
       # @overload friends(options = {})
@@ -254,10 +254,10 @@
         cursor_from_response_with_user(:users, Twitter::User, '/1.1/friends/list.json', args)
       end
       alias_method :following, :friends
 
       # Returns a collection of user IDs that the currently authenticated user does not want to receive retweets from.
-      # @see https://dev.twitter.com/docs/api/1.1/get/friendships/no_retweets/ids
+      # @see https://dev.twitter.com/rest/reference/get/friendships/no_retweets/ids
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       # @return [Array<Integer>]
       # @param options [Hash] A customizable set of options.