Tw v0.1.2

View Source Tw.V1_1.Client (Tw v0.1.2)

Client for Twitter API v1.1.

Link to this section Summary

Types

error()
new_opt()
t()

Functions

decode_json(client, body, opts \\ [])
new(opts)
request(client, method, path, params \\ %{})

Link to this section Types

Link to this type

error()

View Source

Specs

error() :: Tw.V1_1.TwitterAPIError.t() | Exception.t()
Link to this type

new_opt()

View Source

Specs

new_opt() ::
  {:http_client, {Tw.HTTP.Client.implementation(), Tw.HTTP.Client.options()}}
  | {:json,
     {Tw.JSON.Serializer.implementation(), Tw.JSON.Serializer.encode_options(),
      Tw.JSON.Serializer.decode_options()}}
  | {:credentials, Tw.OAuth.V1_0a.Credentials.t()}
Link to this type

t()

View Source

Specs

t() :: %Tw.V1_1.Client{
  credentials: Tw.OAuth.V1_0a.Credentials.t(),
  http_client: {Tw.HTTP.Client.implementation(), Tw.HTTP.Client.options()},
  json:
    {Tw.JSON.Serializer.implementation(), Tw.JSON.Serializer.encode_options(),
     Tw.JSON.Serializer.decode_options()}
}

Link to this section Functions

Link to this function

decode_json(client, body, opts \\ [])

View Source

Specs

decode_json(t(), iodata(), keyword()) :: {:ok, term()} | {:error, Exception.t()}
Link to this function

new(opts)

View Source

Specs

new([new_opt()]) :: t()
Link to this function

request(client, method, path, params \\ %{})

View Source

Specs

request(t(), atom(), binary(), %{required(atom()) => term()}) ::
  {:ok, term()} | {:error, error()}