buffer_api v0.1.0 BufferApi.Client
Client is used to pass configuration to the buffer api.
When making an API call you will need to first grab a client
using BufferApi.Client.from_system/0
or BufferApi.Client.from_application/1
.
Which call you use will be determined by which method of configuration you use
Link to this section Summary
Functions
Returns default BufferApi client to be passed to api functions. For from_application/0 to work the following config is expected
Returns default BufferApi client to be passed to api functions. For from_system/0 to work the following environment variables are expected
Link to this section Functions
from_application(app)
Returns default BufferApi client to be passed to api functions. For from_application/0 to work the following config is expected:
buffer_access_token: ..., buffer_api_url: ...
Examples
iex> BufferApi.Client.from_application() %BufferAPI.Client{...}
from_system()
Returns default BufferApi client to be passed to api functions. For from_system/0 to work the following environment variables are expected:
BUFFER_ACCESS_TOKEN BUFFER_API_URL
Examples
iex> BufferApi.Client.from_application() %BufferAPI.Client{...}