Gusex.Client (gusex v1.3.0)

Copy Markdown View Source

Client module for Gusex, providing actual implementation of functions required to interact with the BIR service. While it is of course possible to use these functions directly, it is recommended to use convenience delegates provided by the main Gusex module.

Summary

Functions

dane_pobierz_pelny_raport(regon, report_name, session)

@spec dane_pobierz_pelny_raport(String.t(), String.t(), Gusex.Types.Session.t()) ::
  {:ok, [struct()]} | {:error, any()}

dane_pobierz_raport_zbiorczy(report_date, report_name, session)

@spec dane_pobierz_raport_zbiorczy(String.t(), String.t(), Gusex.Types.Session.t()) ::
  {:ok, [struct()]} | {:error, any()}

dane_szukaj_podmioty(search_params, session)

@spec dane_szukaj_podmioty(
  Gusex.Types.ParametryWyszukiwania.t() | map(),
  Gusex.Types.Session.t()
) ::
  {:ok, [Gusex.Types.Podmiot.t()]} | {:error, any()}

get_value(param_name, session)

@spec get_value(String.t(), Gusex.Types.Session.t() | nil) ::
  {:ok, String.t()} | {:error, any()}

wyloguj(session)

@spec wyloguj(Gusex.Types.Session.t()) :: {:ok, boolean()} | {:error, any()}

zaloguj(user_key \\ nil, environment \\ nil)

@spec zaloguj(String.t() | nil, :test | :production | nil) ::
  {:ok, Gusex.Types.Session.t()} | {:error, any()}