@spec block_blog(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Blocks a blog.

See /blocks - Block a Blog (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• blocked_tumblelog: the tumblelog to block
• post_id: the anonymous post ID to block

Only one parameter is required at a time.

@spec blog_avatar(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's avatar.

See /avatar - Retrieve Blog Avatar (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• size: the size of the avatar, must be one of 16, 24, 30, 40, 48, 64, 96, 128, 512 (default 64)

@spec blog_blocks(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's blocks.

See /blocks - Retrieve Blog's Blocks (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• limit: number of blocks to retrieve, 1-20 (default 20)
• offset: block number to start at (default 0)

@spec blog_drafts(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's draft posts.

See /posts/draft — Retrieve Draft Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• before_id: returns posts that have appeared before this ID (default 0)
• filter: the post format to return other than HTML, one of "text", "raw"

@spec blog_followed_by(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns if a blog is followed by another blog.

See /followed_by — Check If Followed By Blog (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• other_blogname: a blog identifier
• params: a keyword list of Req options

@spec blog_followers(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's followers.

See /followers — Retrieve Blog's followers (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• limit: number of followers to retrieve, 1-20 (default 20)
• offset: result number to start at (default 0)

@spec blog_following(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's following.

See /following — Retrieve Blog's following (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• limit: number of results to retrieve, 1-20 (default 20)
• offset: followed blog number to start at (default 0)

@spec blog_info(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns general information about a blog.

See /info - Retrieve Blog Info (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• api_key: the application OAuth Consumer Key
• fields[blogs]: a list of fields for partial responses

@spec blog_likes(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's liked posts.

See /likes — Retrieve Blog's Likes (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• api_key: the application OAuth Consumer Key
• limit: number of liked posts to retrieve, 1-20 (default 20)
• offset: liked post number to start at (default 0)
• before: retrieves posts liked before this timestamp
• after: retrieves posts liked after this timestamp

@spec blog_notifications(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's activity items, in reverse chronological order.

See /notifications — Retrieve Blog's Activity Feed (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• before: UNIX epoch timestamp that begins the page (defaults to request time)
• types: a list of one or more types to filter by, one of "like", "reply", "follow", "mention_in_reply", "mention_in_post", "reblog_naked", "reblog_with_content", "ask", "answered_ask", "new_group_blog_member", "post_attribution", "post_flagged", "post_appeal_accepted", "post_appeal_rejected", "what_you_missed", "conversational_note"
• rollups: whether to "roll up" similar activity items into single items
• omit_post_ids: a list of your own post IDs to filter out

@spec blog_posts(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's published posts.

See /posts – Retrieve Published Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• api_key: the application OAuth Consumer Key
• type: the type of post to return, one of "text", "quote", "link", "answer", "video", "audio", "photo", "chat"
• id: a specific post ID
• tag: limits the response to posts with the specified tag(s), can be a string or a list of strings
• limit: number of blocks to retrieve, 1-20 (default 20)
• offset: block number to start at (default 0)
• reblog_info: whether to return reblog information
• notes_info: whether to return notes information
• filter: the post format to return other than HTML, one of "text", "raw"
• before: retrieves posts liked before this timestamp, in seconds
• after: retrieves posts liked after this timestamp, in seconds
• sort: sort order, one of "desc", "asc"
• npf: whether to return posts' content in NPF format

@spec blog_queue(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's queued posts.

See /posts/queue — Retrieve Queued Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• limit: number of blocks to retrieve, 1-20 (default 20)
• offset: block number to start at (default 0)
• filter: the post format to return other than HTML, one of "text", "raw"

@spec blog_reorder_queue(String.t(), String.t() | integer(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Reorders a blog's queue.

See /posts/queue/reorder — Reorder Queued Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to move
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• insert_after: which post ID to move it after (default 0, moves the post to the top)

@spec blog_shuffle_queue(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Shuffles a blog's queue.

See /posts/queue/shuffle - Shuffle Queued Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of Req options

@spec blog_submissions(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a blog's submission posts.

See /posts/submission — Retrieve Submission Posts (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• offset: block number to start at (default 0)
• filter: the post format to return other than HTML, one of "text", "raw"

@spec bulk_block_blogs(String.t(), [String.t()], keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Blocks multiple blogs.

See /blocks/bulk - Block a list of Blogs (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• blocked_blogs: a list of tumblelogs to block
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• force: whether to force the block even if it requires canceling a Post+ Subscription

@spec create_post(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Creates or reblogs a post.

See /posts - Create/Reblog a Post (Neue Post Format) (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• content: an array of NPF content blocks to be used to make the post; in a reblog, this is any content you want to add
• layout: an array of NPF layout objects to be used to lay out the post content
• state: the initial state of the new post, one of "published" or "queued" (default "published")
• publish_on: a future date and time in ISO 8601 format to publish the post, only if state is "queued"
• date: a past date and time in ISO 8601 format to backdate the post
• tags: a list of tags to associate with the post
• source_url: a source attribution for the post content
• send_to_twitter: whether or not to share this via any connected Twitter account on post publish (defaults to the blog's global setting)
• is_private: whether this should be a private answer, if this is an answer
• slug: a custom URL slug to use in the post's permalink URL
• interactability_reblog: who can interact with this when reblogging, one of 'everyone' or 'noone'
• parent_tumblelog_uuid: the unique public identifier of the Tumblelog that's being reblogged from, required if reblogging a post
• parent_post_id: the unique public post ID being reblogged, required if reblogging a post
• reblog_key: the unique per-post hash validating that this is a genuine reblog action, required if reblogging a post
• hide_trail: whether or not to hide the reblog trail with this new post (default false)
• exclude_trail_items: instead of hide_trail, use this to specify a list of specific reblog trail item indexes to exclude from your reblog

@spec delete_post(String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Deletes a blog's post.

See /post/delete – Delete a Post (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to delete
• params: a keyword list of Req options

@spec edit_post(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Edits a blog's post.

See /posts/{post-id} - Editing a Post (Neue Post Format) (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to edit
• params: a keyword list of Req options

@spec mute_post(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Mutes a blog's post.

See /posts/{post-id}/mute – Muting a Post's Notifications (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to mute
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• mute_length_seconds: how many seconds the mute should last (default 0, mutes the post forever)

@spec post_notes(String.t(), integer(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Returns a post's notes.

See /notes - Get notes for a specific Post (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to fetch notes for
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• api_key: the application OAuth Consumer Key
• before_timestamp: fetch notes created before this timestamp; this is a UNIX timestamp in seconds precision, but microseconds precision for "conversation" mode
• mode: the response formatting mode, one of "all", "likes", "conversation", "rollup", "reblogs_with_tags"

@spec remove_blog_block(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Tumbloire.Error.t()}

Remove a blog's block.

See /blocks – Remove a Block (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• params: a keyword list of endpoint parameters or Req options

Endpoint parameters

• blocked_tumblelog: the tumblelog whose block to remove
• anonymous_only: clear all anonymous IP blocks

Only one parameter is required at a time.

@spec unmute_post(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tumbloire.Error.t()}

Unmutes a blog's post.

See /posts/{post-id}/mute – Muting a Post's Notifications (on Tumblr) for more information.

Parameters

• blogname: a blog identifier
• post_id: ID of the post to unmute
• params: a keyword list of Req options