Knock.Api (Knock v0.4.18)
View SourceApi client for interacting with Knock
Summary
Types
Defines available options to pass to an API function
Describes a response from calling an API function
Functions
Executes a delete request against the Knock api.
Executes a get request against the Knock api.
Returns the current version for the library
Executes a post request against the Knock api.
Executes a put request against the Knock api
Types
@type options() :: [Tesla.option() | {:idempotency_key, binary()}] | []
Defines available options to pass to an API function
@type response() :: {:ok, Knock.Response.t()} | {:error, Knock.Response.t()} | {:error, any()}
Describes a response from calling an API function
Functions
@spec delete(Knock.Client.t(), String.t(), options()) :: response()
Executes a delete request against the Knock api.
@spec get(Knock.Client.t(), String.t(), options()) :: response()
Executes a get request against the Knock api.
Returns the current version for the library
@spec post(Knock.Client.t(), String.t(), map(), options()) :: response()
Executes a post request against the Knock api.
@spec put(Knock.Client.t(), String.t(), map(), options()) :: response()
Executes a put request against the Knock api