QlikElixir.Client (qlik_elixir v0.4.0)

View Source

HTTP client wrapper for Qlik API interactions.

Summary

Functions

Makes a DELETE request to the Qlik API.

Makes a GET request to the Qlik API.

Makes a PATCH request to the Qlik API.

Makes a POST request to the Qlik API.

Makes a POST request with binary content.

Makes a PUT request to the Qlik API.

Functions

delete(path, config, opts \\ [])

@spec delete(String.t(), QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a DELETE request to the Qlik API.

get(path, config, opts \\ [])

@spec get(String.t(), QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a GET request to the Qlik API.

patch(path, body, config, opts \\ [])

@spec patch(String.t(), map() | [map()], QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a PATCH request to the Qlik API.

Qlik's patch endpoints take a JSON Patch document (RFC 6902), which is a list of operations; a plain map is accepted for the endpoints that expect one.

post(path, body, config, opts \\ [])

@spec post(String.t(), map() | {:multipart, list()}, QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a POST request to the Qlik API.

post_binary(path, binary, content_type, config, opts \\ [])

@spec post_binary(String.t(), binary(), String.t(), QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a POST request with binary content.

put(path, body, config, opts \\ [])

@spec put(String.t(), map(), QlikElixir.Config.t(), keyword()) ::
  {:ok, map()} | {:error, QlikElixir.Error.t()}

Makes a PUT request to the Qlik API.