TODO.md

TODO

This page contains all the calls from the reddit api along with their implementations in Redd. The API docs are located here.

Account

• GET /api/v1/me
  • Implemented: Redd::Models::Session#me
• GET /api/v1/me/karma
  • Implemented: Redd::Models::Session#karma_breakdown
• GET /api/v1/me/prefs
  • Implemented: Redd::Models::Session#my_preferences
• PATCH /api/v1/me/prefs
  • Implemented: Redd::Models::Session#edit_preferences
• GET /api/v1/me/trophies
  • Won't Implement: Already implemented for User.
• GET /prefs/where
  • Partially Implemented: Redd::Models::Session (for friends, blocked, and trusted)

Captcha

• GET /api/needs_captcha
  • Won't Implement: Not necessary for OAuth2 clients

Flair

• POST [/r/subreddit]/api/clearflairtemplates
  • Not Implemented
• POST [/r/subreddit]/api/deleteflair
  • Implemented: Redd::Models::Subreddit#delete_flair
• POST [/r/subreddit]/api/deleteflairtemplate
  • Not Implemented
• POST [/r/subreddit]/api/flair
  • Implemented: Redd::Models::Subreddit#set_flair
• POST [/r/subreddit]/api/flairconfig
  • Not Implemented
• POST [/r/subreddit]/api/flaircsv
  • Not Implemented
• GET [/r/subreddit]/api/flairlist
  • Implemented: Redd::Models::Subreddit#flair_listing
• POST [/r/subreddit]/api/flairselector
  • Not Implemented
• POST [/r/subreddit]/api/flairtemplate
  • Not Implemented
• GET [/r/subreddit]/api/link_flair
  • Not Implemented
• POST [/r/subreddit]/api/selectflair
  • Implemented: Redd::Models::Subreddit#set_flair_template
• POST [/r/subreddit]/api/setflairenabled
  • Not Implemented
• GET [/r/subreddit]/api/user_flair
  • Not Implemented

Reddit Gold

• POST /api/v1/gold/gild/fullname
  • Implemented: Redd::Models::Gildable#gild
• POST /api/v1/gold/give/username
  • Implemented: Redd::Models::User#gift_gold

Links & Comments

• POST /api/comment
  • Implemented: Redd::Models::Replyable#reply
• POST /api/del
  • Implemented: Redd::Models::Postable#delete
• POST /api/editusertext
  • Implemented: Redd::Models::Postable#edit
• POST /api/hide
  • Implemented: Redd::Models::Postable#hide
• GET [/r/subreddit]/api/info
  • Implemented
    • Redd::Models::Session#from_fullnames
    • Also implemented as part of lazy loaders.
• POST /api/lock
  • Implemented: Redd::Models::Submission#lock
• POST /api/marknsfw
  • Implemented: Redd::Models::Submission#mark_as_nsfw
• GET /api/morechildren
  • TODO: add implementation/documentation link
• POST /api/report
  • Implemented: Redd::Models::Reportable#report
• POST /api/save
  • Implemented: Redd::Models::Postable#save
• GET /api/saved_categories
  • Implemented: Redd::Models::Session#saved_categories
• POST /api/sendreplies
  • Implemented: Redd::Models::Postable#enable_inbox_replies
• POST /api/set_contest_mode
  • Implemented: Redd::Models::Submission#enable_contest_mode
• POST /api/set_subreddit_sticky
  • Implemented: Redd::Models::Submission#make_sticky
• POST /api/set_suggested_sort
  • Implemented: Redd::Models::Submission#set_suggested_sort
• POST /api/spoiler
  • Implemented: Redd::Models::Submission#mark_as_spoiler
• POST /api/store_visits
  • Not Implemented
• POST /api/submit
  • Implemented: Redd::Models::Subreddit#submit
• POST /api/unhide
  • Implemented: Redd::Models::Postable#unhide
• POST /api/unlock
  • Implemented: Redd::Models::Submission#unlock
• POST /api/unmarknsfw
  • Implemented: Redd::Models::Submission#unmark_as_nsfw
• POST /api/unsave
  • Implemented: Redd::Models::Postable#unsave
• POST /api/unspoiler
  • Implemented: Redd::Models::Submission#unmark_as_spoiler
• POST /api/vote
  • Implemented:
    • Redd::Models::Postable#upvote
    • Redd::Models::Postable#downvote
    • Redd::Models::Postable#undo_vote

Listings

• GET /api/trending_subreddits
  • Implemented: Redd::Models::Session#trending_subreddits
• GET /by_id/names
  • Not Implemented: See /api/info.
• GET [/r/subreddit]/comments/article
  • Implemented: Part of lazy-loading in Submission and Comment.
• GET /duplicates/article
  • Implemented: Redd::Models::Submission#duplicates
• GET [/r/subreddit]/hot
  • Implemented: Redd::Models::FrontPage#hot
  • Implemented: Redd::Models::Submission#hot
• GET [/r/subreddit]/new
  • Implemented: Redd::Models::FrontPage#new
  • Implemented: Redd::Models::Submission#new
• GET [/r/subreddit]/random
  • Implemented: Redd::Models::FrontPage#random
  • Implemented: Redd::Models::Submission#random
• GET [/r/subreddit]/rising
  • Implemented: Redd::Models::FrontPage#rising
  • Implemented: Redd::Models::Submission#rising
• GET [/r/subreddit]/sort
  • Implemented: Redd::Models::FrontPage#listing
  • Implemented: Redd::Models::Submission#listing

Live Threads

• GET /api/live/by_id/names
  • Not Implemented
• POST /api/live/create
  • Not Implemented
• GET /api/live/happening_now
  • Not Implemented
• POST /api/live/thread/accept_contributor_invite
  • Not Implemented
• POST /api/live/thread/close_thread
  • Not Implemented
• POST /api/live/thread/delete_update
  • Implemented: Redd::Models::LiveThread#delete_update
• POST /api/live/thread/edit
  • Implemented: Redd::Models::LiveThread#configure
• POST /api/live/thread/invite_contributor
  • Not Implemented
• POST /api/live/thread/leave_contributor
  • Not Implemented
• POST /api/live/thread/report
  • Not Implemented
• POST /api/live/thread/rm_contributor
  • Not Implemented
• POST /api/live/thread/rm_contributor_invite
  • Not Implemented
• POST /api/live/thread/set_contributor_permissions
  • Not Implemented
• POST /api/live/thread/strike_update
  • Implemented: Redd::Models::LiveThread#strike_update
• POST /api/live/thread/update
  • Implemented: Redd::Models::LiveThread#update
• GET /live/thread
  • Implemented: Redd::Models::LiveThread#updates
• GET /live/thread/about
  • Implemented: Redd::Models::Session#live_thread
• GET /live/thread/contributors
  • Implemented: Redd::Models::LiveThread#contributors
• GET /live/thread/discussions
  • Implemented: Redd::Models::LiveThread#discussions

Private Messages

• POST /api/block
  • Implemented: Redd::Models::Inboxable#block
• POST /api/collapse_message
  • Implemented: Redd::Models::Inboxable#collapse
• POST /api/compose
  • Implemented: Redd::Models::Messageable#send_message
• POST /api/del_msg
  • Implemented: Redd::Models::PrivateMessage#delete
• POST /api/read_all_messages
  • Implemented: Redd::Models::Session#read_all_messages
• POST /api/read_message
  • Implemented: Redd::Models::Inboxable#mark_as_read
• POST /api/unblock_subreddit
  • Not Implemented
• POST /api/uncollapse_message
  • Implemented: Redd::Models::Inboxable#uncollapse
• POST /api/unread_message
  • Implemented: Redd::Models::Inboxable#mark_as_unread
• GET /message/where
  • Implemented: Redd::Models::Session#my_messages

Miscellaneous

• GET /api/v1/scopes
  • Not Implemented

Moderation

• GET [/r/subreddit]/about/log
  • Implemented: Redd::Models::Subreddit#mod_log
• GET [/r/subreddit]/about/location
  • Implemented: Redd::Models::Subreddit#moderator_listing
• POST [/r/subreddit]/api/accept_moderator_invite
  • Implemented: Redd::Models::Subreddit#accept_moderator_invite
• POST /api/approve
  • Implemented: Redd::Models::Moderatable#approve
• POST /api/distinguish
  • Implemented: Redd::Models::Moderatable#distinguish
• POST /api/ignore_reports
  • Implemented: Redd::Models::Moderatable#ignore_reports
• POST /api/leavecontributor
  • Implemented: Redd::Models::Subreddit#leave_contributor
• POST /api/leavemoderator
  • Implemented: Redd::Models::Subreddit#leave_moderator
• POST /api/mute_message_author
  • Implemented: Redd::Models::PrivateMessage#mute_author
• POST /api/remove
  • Implemented: Redd::Models::Moderatable#remove
• POST /api/unignore_reports
  • Implemented: Redd::Models::Moderatable#unignore_reports
• POST /api/unmute_message_author
  • Implemented: Redd::Models::PrivateMessage#unmute_author
• GET [/r/subreddit]/stylesheet
  • Implemented: Redd::Models::Subreddit#stylesheet

New Modmail

• POST /api/mod/bulk_read
  • Not Implemented
• GET /api/mod/conversations
  • Implemented: Redd::Models::Modmail#conversations
• POST /api/mod/conversations
  • Implemented: Redd::Models::Modmail#create
• GET /api/mod/conversations/:conversation_id
  • Implemented: Redd::Models::Modmail#get
• POST /api/mod/conversations/:conversation_id
  • Implemented: Redd::Models::ModmailConversation#reply
• POST /api/mod/conversations/:conversation_id/archive
  • Implemented: Redd::Models::ModmailConversation#archive
• DELETE /api/mod/conversations/:conversation_id/highlight
  • Implemented: Redd::Models::ModmailConversation#unhighlight
• POST /api/mod/conversations/:conversation_id/highlight
  • Implemented: Redd::Models::ModmailConversation#highlight
• POST /api/mod/conversations/:conversation_id/mute
  • Implemented: Redd::Models::ModmailConversation#mute
• POST /api/mod/conversations/:conversation_id/unarchive
  • Implemented: Redd::Models::ModmailConversation#unarchive
• POST /api/mod/conversations/:conversation_id/unmute
  • Implemented: Redd::Models::ModmailConversation#unmute
• GET /api/mod/conversations/:conversation_id/user
  • Not Implemented
• POST /api/mod/conversations/read
  • Partially Implemented: Redd::Models::ModmailConversation#mark_as_read
  • Bulk read not implemented
• GET /api/mod/conversations/subreddits
  • Implemented: Redd::Models::Modmail#enrolled
• POST /api/mod/conversations/unread
  • Partially Implemented: Redd::Models::ModmailConversation#mark_as_unread
  • Bulk unread not implemented
• GET /api/mod/conversations/unread/count
  • Implemented: Redd::Models::Modmail#unread_count

Multis

• POST /api/multi/copy
  • Not Implemented
• GET /api/multi/mine
  • Not Implemented
• POST /api/multi/rename
  • Not Implemented
• GET /api/multi/user/username
  • Not Implemented
• DELETE /api/multi/multipath
  • Not Implemented
• GET /api/multi/multipath
  • Implemented: Redd::Models::Session#multi
• POST /api/multi/multipath
  • Not Implemented
• PUT /api/multi/multipath
  • Not Implemented
• GET /api/multi/multipath/description
  • Not Implemented
• PUT /api/multi/multipath/description
  • Not Implemented
• DELETE /api/multi/multipath/r/srname
  • Not Implemented
• GET /api/multi/multipath/r/srname
  • Not Implemented
• PUT /api/multi/multipath/r/srname
  • Not Implemented

Search

• GET [/r/subreddit]/search
  • Implemented: Redd::Models::Searchable#search

Subreddits

• GET [/r/subreddit]/about/where
  • Implemented: Redd::Models::Subreddit#relationship_listing
• POST [/r/subreddit]/api/delete_sr_banner
  • Implemented: Redd::Models::Subreddit#delete_image
• POST [/r/subreddit]/api/delete_sr_header
  • Implemented: Redd::Models::Subreddit#delete_image
• POST [/r/subreddit]/api/delete_sr_icon
  • Implemented: Redd::Models::Subreddit#delete_image
• POST [/r/subreddit]/api/delete_sr_img
  • Implemented: Redd::Models::Subreddit#delete_image
• GET /api/recommend/sr/srnames
  • Not Implemented
• POST /api/search_reddit_names
  • Not Implemented
• POST /api/search_subreddits
  • Not Implemented
• POST /api/site_admin
  • Implemented: Redd::Models::Subreddit#modify_settings
• GET [/r/subreddit]/api/submit_text
  • Won't Implement: Already covered by the Subreddit model.
• GET /api/subreddit_autocomplete
  • Not Implemented
• POST [/r/subreddit]/api/subreddit_stylesheet
  • Implemented: Redd::Models::Subreddit#update_stylesheet
• GET /api/subreddits_by_topic
  • Not Implemented
• POST /api/subscribe
  • Implemented: Redd::Models::Subreddit#subscribe
• POST [/r/subreddit]/api/upload_sr_img
  • Implemented: Redd::Models::Subreddit#upload_image
• GET /r/subreddit/about
  • Implemented: Redd::Models::Session#subreddit
• GET /r/subreddit/about/edit
  • Implemented: Redd::Models::Subreddit#settings
• GET /r/subreddit/about/rules
  • Not Implemented
• GET /r/subreddit/about/traffic
  • Not Implemented
• GET [/r/subreddit]/sidebar
  • Won't Implement: Already covered by Subreddit's "description" property.
• GET [/r/subreddit]/sticky
  • Not Implemented
• GET /subreddits/mine/where
  • Implemented: Redd::Models::Session#my_subreddits
• GET /subreddits/search
  • Not Implemented
• GET /subreddits/where
  • Not Implemented
• GET /users/where
  • Not Implemented

Users

• POST /api/block_user
  • Implemented: Redd::Models::User#block
• POST [/r/subreddit]/api/friend
  • Implemented: Used in multiple methods.
• POST /api/report_user
  • Not Implemented
• POST [/r/subreddit]/api/setpermissions
  • Not Implemented
• POST [/r/subreddit]/api/unfriend
  • Implemented: Used in multiple methods.
• GET /api/user_data_by_account_ids
  • Not Implemented: Redd::Models::Session#from_fullnames
  • Currently commented out (will uncoment when adding cache check feature to lazy_lazer).
  • Not implemented for batch calls, only individual.
• GET /api/username_available
  • Implemented: Redd::Models::Session#username_available?
• DELETE /api/v1/me/friends/username
  • Implemented: Redd::Models::User#unfriend
• GET /api/v1/me/friends/username
  • TODO: add implementation/documentation link
• PUT /api/v1/me/friends/username
  • Implemented: Redd::Models::User#friend
• GET /api/v1/user/username/trophies
  • Implemented: Redd::Models::User#trophies
• GET /user/username/about
  • Implemented: Redd::Models::Session#user
• GET /user/username/where
  • Implemented: Redd::Models::User#listing

Wiki

• POST [/r/subreddit]/api/wiki/alloweditor/act
  • Not Implemented
• POST [/r/subreddit]/api/wiki/edit
  • Implemented: Redd::Models::WikiPage#edit
• POST [/r/subreddit]/api/wiki/hide
  • Not Implemented
• POST [/r/subreddit]/api/wiki/revert
  • Not Implemented
• GET [/r/subreddit]/wiki/discussions/page
  • Not Implemented
• GET [/r/subreddit]/wiki/pages
  • Implemented: Redd::Models::FrontPage#wiki_pages
  • Implemented: Redd::Models::Subreddit#wiki_pages
• GET [/r/subreddit]/wiki/revisions
  • Not Implemented
• GET [/r/subreddit]/wiki/revisions/page
  • Not Implemented
• GET [/r/subreddit]/wiki/settings/page
  • Not Implemented
• POST [/r/subreddit]/wiki/settings/page
  • Not Implemented
• GET [/r/subreddit]/wiki/page
  • Implemented: Redd::Models::FrontPage#wiki_page
  • Implemented: Redd::Models::Subreddit#wiki_page