upvest v0.1.1 Upvest View Source

An HTTP client for Upvest.

All tenancy related operations must be authenticated using the API Keys Authentication, whereas all actions on a user's behalf need to be authenticated via OAuth. The API calls are built along with those two authentication objects.

All API calls return either {:ok, response} or {:error, error}, and where possible succesful response are transformed into Elixir structs mapped to the corresponding Upvest API resource.

Link to this section Summary

Functions

Executes the request and returns the response.

Returns the current version of the library

Link to this section Types

Link to this type

headers()

View Source
headers() :: map()
Link to this type

http_method()

View Source
http_method() :: :get | :post | :patch | :delete
Link to this type

response()

View Source
response() :: {:ok, any()} | {:ok, binary()} | {:error, error()}

Link to this section Functions

Link to this function

request(action, endpoint, data, client)

View Source
request(http_method(), binary(), map(), Upvest.Client.t()) :: response()

Executes the request and returns the response.

Returns the current version of the library