twython/twython3k/twitter_endpoints.py

"""
	A huge map of every Twitter API endpoint to a function definition in Twython.

	Parameters that need to be embedded in the URL are treated with mustaches, e.g:

	{{version}}, etc

	When creating new endpoint definitions, keep in mind that the name of the mustache
	will be replaced with the keyword that gets passed in to the function at call time.

	i.e, in this case, if I pass version = 47 to any function, {{version}} will be replaced
	with 47, instead of defaulting to 1 (said defaulting takes place at conversion time).
"""

# Base Twitter API url, no need to repeat this junk...
base_url = 'http://api.twitter.com/{{version}}'

api_table  = {
	'getRateLimitStatus': {
		'url': '/account/rate_limit_status.json',
		'method': 'GET',
	},
	
	'verifyCredentials': {
		'url': '/account/verify_credentials.json',
		'method': 'GET',
	},
	
	'endSession' : {
		'url': '/account/end_session.json',
		'method': 'POST',
	},
	
	# Timeline methods
	'getPublicTimeline': {
		'url': '/statuses/public_timeline.json',
		'method': 'GET',
	},
	'getHomeTimeline': {
		'url': '/statuses/home_timeline.json',
		'method': 'GET',
	},
	'getUserTimeline': {
		'url': '/statuses/user_timeline.json',
		'method': 'GET',
	},
	'getFriendsTimeline': {
		'url': '/statuses/friends_timeline.json',
		'method': 'GET',
	},
	
	# Interfacing with friends/followers
	'getUserMentions': {
		'url': '/statuses/mentions.json',
		'method': 'GET',
	},
	'getFriendsStatus': {
		'url': '/statuses/friends.json',
		'method': 'GET',
	},
	'getFollowersStatus': {
		'url': '/statuses/followers.json',
		'method': 'GET',
	},
	'createFriendship': {
		'url': '/friendships/create.json',
		'method': 'POST',
	},
	'destroyFriendship': {
		'url': '/friendships/destroy.json',
		'method': 'POST',
	},
	'getFriendsIDs': {
		'url': '/friends/ids.json',
		'method': 'GET',
	},
	'getFollowersIDs': {
		'url': '/followers/ids.json',
		'method': 'GET',
	},
	'getIncomingFriendshipIDs': {
		'url': '/friendships/incoming.json',
		'method': 'GET',
	},
	'getOutgoingFriendshipIDs': {
		'url': '/friendships/outgoing.json',
		'method': 'GET',
	},
	
	# Retweets
	'reTweet': {
		'url': '/statuses/retweet/{{id}}.json',
		'method': 'POST',
	},
	'getRetweets': {
		'url': '/statuses/retweets/{{id}}.json',
		'method': 'GET',
	},
	'retweetedOfMe': {
		'url': '/statuses/retweets_of_me.json',
		'method': 'GET',
	},
	'retweetedByMe': {
		'url': '/statuses/retweeted_by_me.json',
		'method': 'GET',
	},
	'retweetedToMe': {
		'url': '/statuses/retweeted_to_me.json',
		'method': 'GET',
	},
	
	# User methods
	'showUser': {
		'url': '/users/show.json',
		'method': 'GET',
	},
	'searchUsers': {
		'url': '/users/search.json',
		'method': 'GET',
	},
	
	# Status methods - showing, updating, destroying, etc.
	'showStatus': {
		'url': '/statuses/show/{{id}}.json',
		'method': 'GET',
	},
	'updateStatus': {
		'url': '/statuses/update.json',
		'method': 'POST',
	},
	'destroyStatus': {
		'url': '/statuses/destroy/{{id}}.json',
		'method': 'POST',
	},
	
	# Direct Messages - getting, sending, effing, etc.
	'getDirectMessages': {
		'url': '/direct_messages.json',
		'method': 'GET',
	},
	'getSentMessages': {
		'url': '/direct_messages/sent.json',
		'method': 'GET',
	},
	'sendDirectMessage': {
		'url': '/direct_messages/new.json',
		'method': 'POST',
	},
	'destroyDirectMessage': {
		'url': '/direct_messages/destroy/{{id}}.json',
		'method': 'POST',
	},
	
	# Friendship methods
	'checkIfFriendshipExists': {
		'url': '/friendships/exists.json',
		'method': 'GET',
	},
	'showFriendship': {
		'url': '/friendships/show.json',
		'method': 'GET',
	},
	
	# Profile methods
	'updateProfile': {
		'url': '/account/update_profile.json',
		'method': 'POST',
	},
	'updateProfileColors': {
		'url': '/account/update_profile_colors.json',
		'method': 'POST',
	},
	
	# Favorites methods
	'getFavorites': {
		'url': '/favorites.json',
		'method': 'GET',
	},
	'createFavorite': {
		'url': '/favorites/create/{{id}}.json',
		'method': 'POST',
	},
	'destroyFavorite': {
		'url': '/favorites/destroy/{{id}}.json',
		'method': 'POST',
	},
	
	# Blocking methods
	'createBlock': {
		'url': '/blocks/create/{{id}}.json',
		'method': 'POST',
	},
	'destroyBlock': {
		'url': '/blocks/destroy/{{id}}.json',
		'method': 'POST',
	},
	'getBlocking': {
		'url': '/blocks/blocking.json',
		'method': 'GET',
	},
	'getBlockedIDs': {
		'url': '/blocks/blocking/ids.json',
		'method': 'GET',
	},
	'checkIfBlockExists': {
		'url': '/blocks/exists.json',
		'method': 'GET',
	},
	
	# Trending methods
	'getCurrentTrends': {
		'url': '/trends/current.json',
		'method': 'GET',
	},
	'getDailyTrends': {
		'url': '/trends/daily.json',
		'method': 'GET',
	},
	'getWeeklyTrends': {
		'url': '/trends/weekly.json',
		'method': 'GET',
	},
	'availableTrends': {
		'url': '/trends/available.json',
		'method': 'GET',
	},
	'trendsByLocation': {
		'url': '/trends/{{woeid}}.json',
		'method': 'GET',
	},
	
	# Saved Searches
	'getSavedSearches': {
		'url': '/saved_searches.json',
		'method': 'GET',
	},
	'showSavedSearch': {
		'url': '/saved_searches/show/{{id}}.json',
		'method': 'GET',
	},
	'createSavedSearch': {
		'url': '/saved_searches/create.json',
		'method': 'GET',
	},
	'destroySavedSearch': {
		'url': '/saved_searches/destroy/{{id}}.json',
		'method': 'GET',
	},
	
	# List API methods/endpoints. Fairly exhaustive and annoying in general. ;P
	'createList': {
		'url': '/{{username}}/lists.json',
		'method': 'POST',
	},
	'updateList': {
		'url': '/{{username}}/lists/{{list_id}}.json',
		'method': 'POST',
	},
	'showLists': {
		'url': '/{{username}}/lists.json',
		'method': 'GET',
	},
	'getListMemberships': {
		'url': '/{{username}}/lists/memberships.json',
		'method': 'GET',
	},
	'getListSubscriptions': {
		'url': '/{{username}}/lists/subscriptions.json',
		'method': 'GET',
	},
	'deleteList': {
		'url': '/{{username}}/lists/{{list_id}}.json',
		'method': 'DELETE',
	},
	'getListTimeline': {
		'url': '/{{username}}/lists/{{list_id}}/statuses.json',
		'method': 'GET',
	},
	'getSpecificList': {
		'url': '/{{username}}/lists/{{list_id}}/statuses.json',
		'method': 'GET',
	},
	'addListMember': {
		'url': '/{{username}}/{{list_id}}/members.json',
		'method': 'POST',
	},
	'getListMembers': {
		'url': '/{{username}}/{{list_id}}/members.json',
		'method': 'GET',
	},
	'deleteListMember': {
		'url': '/{{username}}/{{list_id}}/members.json',
		'method': 'DELETE',
	},
	'getListSubscribers': {
		'url': '/{{username}}/{{list_id}}/subscribers.json',
		'method': 'GET',
	},
	'subscribeToList': {
		'url': '/{{username}}/{{list_id}}/subscribers.json',
		'method': 'POST',
	},
	'unsubscribeFromList': {
		'url': '/{{username}}/{{list_id}}/subscribers.json',
		'method': 'DELETE',
	},

	# The one-offs
	'notificationFollow': {
		'url': '/notifications/follow/follow.json',
		'method': 'POST',
	},
	'notificationLeave': {
		'url': '/notifications/leave/leave.json',
		'method': 'POST',
	},
	'updateDeliveryService': {
		'url': '/account/update_delivery_device.json',
		'method': 'POST',
	},
	'reportSpam': {
		'url': '/report_spam.json',
		'method': 'POST',
	},
}