ex_figures v0.1.1 ExFigures View Source

Elixir wrapper for Appfigures API based on Tesla library.

Appfigures provides a RESTful way to interact with reports and account data.

Appfigures provides two ways of authentication:

  • basic auth
  • OAuth 1.0

Right now client supports only basic auth method.

Appfigures require that any client made publicly available uses OAuth 1.0. So make sure that's your client is for internal/team use only.

Link to this section Summary

Types

Represents ExFigures client init options

Represents ExFigures api call result wrapped in :ok/:error tuple

t()

Represents ExFigures client

Functions

Creates ExFigures client. The options passed affect authentication and middleware extending.

Link to this section Types

Link to this type

option() View Source
option() ::
  {:username, binary() | {:system, binary()}}
  | {:password, binary() | {:system, binary()}}
  | {:client_key, binary() | {:system, binary()}}
  | {:middleware, [any()]}

Represents ExFigures client init options

Represents ExFigures api call result wrapped in :ok/:error tuple

Represents ExFigures client

Link to this section Functions

Link to this function

client(opts \\ []) View Source
client([option()]) :: ExFigures.t()

Creates ExFigures client. The options passed affect authentication and middleware extending.

Options:

  • username - appfigures account's username or email address. In case of empty client uses :ex_figures, :username config variable.
  • password - appfigures account's password. In case of empty client uses :ex_figures, :password config variable.
  • client_key - appfigures api client key. In case of empty client uses :ex_figures, :password config variable.
  • middleware - list of additional Tesla middle. Useful for extending client with additional functionality like instrumentation or logging.