RRPproxy.Client (RRPproxy.net API v0.1.7) View Source

Documentation for RRPproxy.Client which holds API credentials.

It is used for low-level communication and should not be used directly by users of this library.

Link to this section Summary

Link to this section Types

Specs

t() :: %RRPproxy.Client{
  ote: boolean(),
  password: String.t(),
  username: String.t()
}

Link to this section Functions

Link to this function

new(username \\ Application.get_env(:rrpproxy, :username), password \\ Application.get_env(:rrpproxy, :password), ote \\ Application.get_env(:rrpproxy, :ote, true))

View Source

Specs

new(String.t() | nil, String.t() | nil, boolean() | nil) :: t()

Creates a new API Credentials object.