Pivo v0.1.0 Pivo.TrackerAPI View Source

Tracker API module.

Process requests to the Pivotal's Tracker API.

Link to this section Summary

Functions

Issues a request with the given http method to the given url path.

Link to this section Functions

Issues a request with the given http method to the given url path.

Receives a params keyword list with the following keys:

  • Required

    • http_method - HTTP method as an atom (:get, :post, :put, :delete)
    • url_path - target url path as a binary string or char list
  • Optional

    • body - request body
    • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
    • options - keyword list

This function returns {:ok, response} if the request is successful, {:error, reason} otherwise.

Examples

request(http_method: :get, url_path: "/me")
Link to this function

request(method, url_path, body \\ nil, headers \\ [], options \\ [])

View Source

See request/1.

See request/1.