Saves / adds a new article in Pocket.

Parameters

client - either a Pocketeer.Client struct or a map that contains consumer_key and access_token.

options - an options map with properties to save

• url - The url to save in Pocket (required)
• tags - A list of tags (optional)
• title - The title of the entry (optional)
• tweet_id - The id of the tweet to link the item with (optional)

Examples

To store an item with url, title and tags with a Pocketeer.Client.

client = Pocketeer.Client.new("consumer_key", "access_token")
Pocketeer.add(client, %{url: "http://example.com", title: "Hello", tags: "news"})

For storing an article with reference to a tweet.

options = %{url: "http://linkto.me", tweet_id: "5678"}
Pocketeer.add(%{consumer_key: "abcd", access_token: "1234"}, options)

Fetches a list of articles / items from Pocket with default settings.

See documentation of Pocketeer.get/2 for more details.

Fetches a list of articles / items from the Pocket API.

The method allows to either provide a map of options as defined in the official API documentation or by building a Pocketeer.Get struct, which might be easier to use

Parameters

• client: The Pocketeer.Client struct with consumer key and access token
• options: The options struct for the Retrieve API endpoint

Examples

It is possible to use a map with options, see the Pocket API documentation

# returns a list of the 10 newest favorites in full detail
client = Pocketeer.Client.new("consumer_key", "access_token")
{:ok, response} = Pocketeer.get(client, %{sort: :newest, favorite: 1, detailType: :complete, count: 10})

For more convenience there is also the Pocketeer.Get struct, that accepts a list of arguments, filters and transforms data to be compatible with this function.

# find the oldest 5 untagged videos from youtube
options = Pocketeer.Get.new(%{sort: :oldest, count: 5, domain: "youtube.com", tag: :untagged, contentType: :video})
{:ok, response} = Pocketeer.get(%{consumer_key: "abcd", access_token: "1234", options})

Fetches a list of articles / items from the Pocket API.

Parameters

• client: The API client with consumer key and access token
• options: The options struct for the Retrieve API endpoint

Returns the body of the Pocketeer.Response or raises an exception with error message.

Send a single action or a list of actions to Pocket's Modify endpoint. Either a map with defined options can be given or a Pocketeer.Item struct.

Examples

It's possible to send a single action via a map of options, see linked Pocket's API documentation.

# archive a single item with a given id.
client = Client.new("consumer_key", "access_token")
post(%{action: "archive", item_id: "1234"}, client)

The function also supports a bulk operation, where several actions can be given as a list.

client = Client.new("consumer_key", "access_token")
items = [
  %{action: "favorite", item_id: "123"},
  %{action: "delete", item_id: "456"}
]
post(items, client)

The preferred way to send a list of actions to the API is by constructing them via Pocketeer.Item.

# same as above
client = Client.new("consumer_key", "access_token")
items = Item.new |> Item.archive("123") |> Item.delete("456")
post(items, client)
# or
Item.new
|> Item.archive("123")
|> Item.delete("456")
|> post(client)